yggdrasil-network.github.io/installation.md

---
sitemap: true
---

# Installation

Yggdrasil can be downloaded for major platforms from our [GitHub Releases](https://github.com/yggdrasil-network/yggdrasil-go/releases) page. Additionally, installation guides are available for the following platforms/distributions.

Once you have installed Yggdrasil, take a look at:

- [Configuration](configuration.md) — information about configuring Yggdrasil 
- [Public Peers](https://github.com/yggdrasil-network/public-peers) — public nodes to connect to
- [Public Services](services.md) — services running inside the Yggdrasil Network

### Linux

Yggdrasil is well supported on Linux. There are a number of distribution packages and additional installation instructions available:

- [Debian, Ubuntu, elementaryOS, Linux Mint and similar](installation-linux-deb.md)
- [Red Hat Enterprise Linux, Fedora, CentOS and similar](installation-linux-rpm.md)
- [Gentoo Linux](installation-linux-gentoo.md)
- [OpenWrt](installation-linux-openwrt.md)
- [Manual install or build from source](installation-linux-other.md)

### macOS

Yggdrasil is well supported on macOS. The preferred installation method is the `.pkg` installer:

- [macOS `.pkg` installer](installation-macos-pkg.md)
- [Manual install or build from source](installation-macos-other.md)

### Windows

Yggdrasil works on Windows and [an MSI installer is available](installation-windows.md), but the installer is supported on a best-effort basis only and is not well tested. 

### iOS

Yggdrasil is supported on iOS with the following applications:

* [Yggdrasil for iOS on TestFlight](https://testflight.apple.com/join/jZNsIkRr), reference client based on the [v0.4 release candidate](https://yggdrasil-network.github.io/2021/06/19/preparing-for-v0-4.html) ([source code](https://github.com/yggdrasil-network/yggdrasil-ios))

### Android

Yggdrasil is supported on Android with the following applications:

* [Yggdrasil for Android](https://github.com/yggdrasil-network/yggdrasil-android/releases), reference client based on the [v0.4 release candidate](https://yggdrasil-network.github.io/2021/06/19/preparing-for-v0-4.html)
* [Crispa for Android](https://github.com/yggdrasil-network/crispa-android/releases), contributed by the community

### FreeBSD

Yggdrasil is well supported on FreeBSD and [an official `net/yggdrasil` port](https://www.freshports.org/net/yggdrasil/) is available.

### Ubiquiti EdgeRouter

Yggdrasil is well supported on EdgeOS 2.x and [packages are available](installation-linux-edgeos.md).
Add some Linux installation pages 2019-03-15 17:32:23 +00:00			`---`
			`sitemap: true`
			`---`

			`# Installation`

Slight website refresh 2021-06-06 11:14:51 +00:00			`Yggdrasil can be downloaded for major platforms from our [GitHub Releases](https://github.com/yggdrasil-network/yggdrasil-go/releases) page. Additionally, installation guides are available for the following platforms/distributions.`
Add macOS installer pages 2019-03-15 17:41:28 +00:00
Link to public services, peers, config from installation page 2021-06-06 13:15:24 +00:00			`Once you have installed Yggdrasil, take a look at:`

			`- [Configuration](configuration.md) — information about configuring Yggdrasil`
			`- [Public Peers](https://github.com/yggdrasil-network/public-peers) — public nodes to connect to`
			`- [Public Services](services.md) — services running inside the Yggdrasil Network`

Update installation.md 2021-06-10 13:05:06 +00:00			`### Linux`
Add some Linux installation pages 2019-03-15 17:32:23 +00:00
Slight website refresh 2021-06-06 11:14:51 +00:00			`Yggdrasil is well supported on Linux. There are a number of distribution packages and additional installation instructions available:`

tweaks 2019-03-15 18:27:41 +00:00			`- [Debian, Ubuntu, elementaryOS, Linux Mint and similar](installation-linux-deb.md)`
			`- [Red Hat Enterprise Linux, Fedora, CentOS and similar](installation-linux-rpm.md)`
Installation guide for Gentoo Linux Yggdrasil has been added to the Gentoo GURU repository (somewhat like AUR for Gentoo): https://gitweb.gentoo.org/repo/proj/guru.git/tree/net-p2p/yggdrasil-go This commit adds a guide for installing Yggdrasil using this repository on Gentoo. 2020-03-28 10:11:37 +00:00			`- [Gentoo Linux](installation-linux-gentoo.md)`
openwrt: supported since 17.01 (#228) 2023-01-24 21:21:37 +00:00			`- [OpenWrt](installation-linux-openwrt.md)`
Add binary install steps for Linux/macOS 2019-03-15 17:47:53 +00:00			`- [Manual install or build from source](installation-linux-other.md)`
Add macOS installer pages 2019-03-15 17:41:28 +00:00
Update installation.md 2021-06-10 13:05:06 +00:00			`### macOS`
Add macOS installer pages 2019-03-15 17:41:28 +00:00
Slight website refresh 2021-06-06 11:14:51 +00:00			Yggdrasil is well supported on macOS. The preferred installation method is the `.pkg` installer:

tweaks 2019-03-15 18:27:41 +00:00			- [macOS `.pkg` installer](installation-macos-pkg.md)
Fix macos-other link 2019-03-15 17:48:54 +00:00			`- [Manual install or build from source](installation-macos-other.md)`
Add iOS platform pages 2019-03-15 18:02:34 +00:00
Update installation.md 2021-06-10 13:05:06 +00:00			`### Windows`
Windows installation page 2019-07-20 10:28:57 +00:00
Update installation.md 2021-06-16 16:43:14 +00:00			`Yggdrasil works on Windows and [an MSI installer is available](installation-windows.md), but the installer is supported on a best-effort basis only and is not well tested.`
Slight website refresh 2021-06-06 11:14:51 +00:00
Update installation.md 2021-06-24 18:55:06 +00:00			`### iOS`
Slight website refresh 2021-06-06 11:14:51 +00:00
Update installation.md 2021-06-25 16:52:27 +00:00			`Yggdrasil is supported on iOS with the following applications:`

			`* [Yggdrasil for iOS on TestFlight](https://testflight.apple.com/join/jZNsIkRr), reference client based on the [v0.4 release candidate](https://yggdrasil-network.github.io/2021/06/19/preparing-for-v0-4.html) ([source code](https://github.com/yggdrasil-network/yggdrasil-ios))`
Slight website refresh 2021-06-06 11:14:51 +00:00
Update installation.md 2021-06-10 13:05:06 +00:00			`### Android`
Slight website refresh 2021-06-06 11:14:51 +00:00
Update installation.md 2021-06-25 16:52:27 +00:00			`Yggdrasil is supported on Android with the following applications:`

			`* [Yggdrasil for Android](https://github.com/yggdrasil-network/yggdrasil-android/releases), reference client based on the [v0.4 release candidate](https://yggdrasil-network.github.io/2021/06/19/preparing-for-v0-4.html)`
			`* [Crispa for Android](https://github.com/yggdrasil-network/crispa-android/releases), contributed by the community`
Slight website refresh 2021-06-06 11:14:51 +00:00
Update installation.md 2021-06-24 18:55:06 +00:00			`### FreeBSD`

			Yggdrasil is well supported on FreeBSD and [an official `net/yggdrasil` port](https://www.freshports.org/net/yggdrasil/) is available.
Slight website refresh 2021-06-06 11:14:51 +00:00
Update installation.md 2021-06-24 18:55:06 +00:00			`### Ubiquiti EdgeRouter`

			`Yggdrasil is well supported on EdgeOS 2.x and [packages are available](installation-linux-edgeos.md).`