mirror of
https://github.com/cwinfo/yggdrasil-network.github.io.git
synced 2024-11-09 15:40:27 +00:00
Add macOS installer pages
This commit is contained in:
parent
813344e8c7
commit
6447dde136
@ -36,6 +36,7 @@ sudo cp {yggdrasil,yggdrasilctl} /usr/local/bin
|
||||
```
|
||||
|
||||
##### Debug builds
|
||||
|
||||
You can create a debug build by running `./build -d` instead of
|
||||
`./build`. Debug builds contain profiling code as well as additional debugging
|
||||
symbols. They are likely to be larger files as a result.
|
||||
|
80
installation-macos-other.md
Normal file
80
installation-macos-other.md
Normal file
@ -0,0 +1,80 @@
|
||||
---
|
||||
tags: dontlink
|
||||
sitemap: true
|
||||
---
|
||||
|
||||
# Installing manually on macOS
|
||||
|
||||
Yggdrasil is supported on macOS. You can either [download the latest binary from
|
||||
CircleCI](builds.md) or you can build from source.
|
||||
|
||||
### Build from source
|
||||
|
||||
macOS has most of the tools needed to build Yggdrasil from source - you just
|
||||
need to install the Go toolchain. Yggdrasil requires Go 1.11 as a minimum.
|
||||
|
||||
- Install [the latest version of Go](https://golang.org/dl/) for your platform
|
||||
|
||||
Clone the repository and build:
|
||||
```
|
||||
cd /path/to
|
||||
git clone https://github.com/yggdrasil-network/yggdrasil-go
|
||||
```
|
||||
|
||||
Build Yggdrasil:
|
||||
```
|
||||
cd /path/to/yggdrasil-go
|
||||
./build
|
||||
```
|
||||
|
||||
The build will produce `yggdrasil` and `yggdrasilctl` binaries. System Integrity
|
||||
Protection in macOS prevents you from copying files into `/usr/bin`, therefore
|
||||
you should install into `/usr/local/bin`:
|
||||
```
|
||||
sudo cp {yggdrasil,yggdrasilctl} /usr/local/bin
|
||||
```
|
||||
|
||||
##### Debug builds
|
||||
|
||||
You can create a debug build by running `./build -d` instead of
|
||||
`./build`. Debug builds contain profiling code as well as additional debugging
|
||||
symbols. They are likely to be larger files as a result.
|
||||
|
||||
### Install launchd service
|
||||
|
||||
launchd service scripts are included in the `contrib/macos/` folder so that it
|
||||
runs automatically in the background (using `/etc/yggdrasil.conf` for
|
||||
configuration).
|
||||
|
||||
Copy the service files:
|
||||
```
|
||||
sudo cp contrib/macos/yggdrasil.plist /Library/LaunchDaemons/
|
||||
```
|
||||
|
||||
Enable and start Yggdrasil:
|
||||
```
|
||||
sudo launchctl load /Library/LaunchDaemons/yggdrasil.plist
|
||||
sudo launchctl start /Library/LaunchDaemons/yggdrasil.plist
|
||||
```
|
||||
|
||||
Once installed as a launchd service, you can read the `yggdrasil` output in the
|
||||
following files:
|
||||
```
|
||||
tail -f /tmp/yggdrasil.stdout.log
|
||||
tail -f /tmp/yggdrasil.stderr.log
|
||||
```
|
||||
|
||||
### Generate configuration
|
||||
|
||||
Generate an initial Yggdrasil configuration file:
|
||||
```
|
||||
sudo yggdrasil -genconf > /etc/yggdrasil.conf
|
||||
```
|
||||
|
||||
You can make changes to this file as described in the
|
||||
[Configuration](configuration.md) page.
|
||||
|
||||
### After installation
|
||||
|
||||
Read the [macOS platform page](platform-macos.md) page for further
|
||||
information about macOS platform support.
|
35
installation-macos-pkg.md
Normal file
35
installation-macos-pkg.md
Normal file
@ -0,0 +1,35 @@
|
||||
---
|
||||
tags: dontlink
|
||||
sitemap: true
|
||||
---
|
||||
|
||||
# Installing using the macOS installer
|
||||
|
||||
Yggdrasil is supported on macOS. Visit our [Builds](builds.md) page and download
|
||||
the relevant `.pkg` file
|
||||
|
||||
### Install using Finder
|
||||
|
||||
Locate the downloaded `.pkg` installer in Finder. Right-click it and click Open.
|
||||
|
||||
Step through the installer as usual.
|
||||
|
||||
Once completed, the Yggdrasil configuration will have automatically been
|
||||
generated, the `launchd` service will have been installed and the service will
|
||||
be running.
|
||||
|
||||
### Install using Terminal
|
||||
|
||||
Open Terminal.app and install the package:
|
||||
```
|
||||
sudo installer -pkg /path/to/yggdrasil-xxx-macos.pkg -target /
|
||||
```
|
||||
|
||||
Once completed, the Yggdrasil configuration will have automatically been
|
||||
generated, the `launchd` service will have been installed and the service will
|
||||
be running.
|
||||
|
||||
### After installation
|
||||
|
||||
Read the [macOS platform page](platform-macos.md) page for further
|
||||
information about macOS platform support.
|
@ -4,9 +4,16 @@ sitemap: true
|
||||
|
||||
# Installation
|
||||
|
||||
Installation guides are available for the following platforms/distributions.
|
||||
|
||||
## Linux
|
||||
|
||||
- [Debian, Ubuntu, elementaryOS](installation-linux-deb.md)
|
||||
- [Red Hat Enterprise Linux, Fedora, CentOS](installation-linux-rpm.md)
|
||||
- [Ubiquiti EdgeOS](installation-linux-edgeos.md)
|
||||
- [Other distributions or build from source](installation-linux-other.md)
|
||||
|
||||
## macOS
|
||||
|
||||
- [macOS installer](installation-macos-pkg.md)
|
||||
- [Build from source](installation-linux-other.md)
|
||||
|
Loading…
Reference in New Issue
Block a user