Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

self hosting copy updates #229

Merged
merged 2 commits into from
Jan 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/roots.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ description: How to host your own root servers

### Creating Your Own Roots (a.k.a. Moons)

:::warning
Using moons is now discouraged. Please contact us for advice and alternatives.
:::

All ZeroTier nodes
on a planet effectively inhabit a single data center. This makes it easy
to directly connect devices anywhere, but it has the disadvantage of not
Expand Down
18 changes: 12 additions & 6 deletions docs/selfhosting.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,29 @@ title: Self Hosting
description: Host your own ZeroTier infrastructure
---

Hosting your own ZeroTier infrastructure is easy. There are 2 types of ZeroTier infrastructure and each serves a different role:
There are 2 types of ZeroTier infrastructure that can be self-hosted.

### Network Controllers

Controllers handle [Virtual Layer 2](protocol#vl2). No traffic is handled by controllers. ZeroTier Inc runs controllers with a web UI and API at [ZeroTier Central](https://my.zerotier.com). You can [self-host controllers](controller), but we don't currently offer the web UI for self-hosting. You'll have to use the json api.
Controllers handle [Virtual Layer 2](protocol#vl2). No traffic is handled by controllers.

The controller is open-source. Please check the [license](https://github.com/zerotier/ZeroTierOne/blob/master/LICENSE.txt). It's built in to the zerotier-one binary.
ZeroTier Inc runs controllers with a web UI and API at [ZeroTier Central](https://my.zerotier.com). You can [self-host controllers](controller), but we don't currently offer the web UI for self-hosting. You'll have to use the [json api](https://docs.zerotier.com/api/service/ref-v1/#tag/Controller) to manage your networks.

The controller is open-source. Please check the [license](https://github.com/zerotier/ZeroTierOne/blob/master/LICENSE.txt). The controller service is built in to the zerotier-one binary if you use our [downloads](https://www.zerotier.com/download).

### Roots

Roots handle [Virtual Layer 1](protocol#peerdiscovery).
ZeroTier, Inc hosts the roots. Setup for peer to peer connections happen via the roots. If p2p connections can't be made, traffic is "relayed" through these roots.
ZeroTier, Inc hosts the roots. Setup for peer to peer connections happen via the roots. If peer to peer connections can't be made, traffic is "relayed" through these roots.

:::note
All traffic is end-to-end encrypted. The roots can't read anything that passes through them.
:::

You can [host your own roots](roots) (previously called "moons") in addition to ZeroTier's, but we can't provide support for removing ZeroTier's roots (unless you are a large enterprise customer). The mobile apps don't currently support custom roots.
You can [host your own roots](roots) ("moons") in addition to ZeroTier's, but we can't provide support for removing ZeroTier's roots except to enterprise customers. The mobile apps don't currently support custom roots.

If you are not using ZeroTier Inc's default root setup, your nodes won't be talk to nodes that are. Only devices configured with your custom roots will find each other.

If you want to add additional roots and still talk to standard nodes, see [moons](roots).

If you are using a custom root setup, your nodes won't be able to find standard nodes. If you want to add additional roots and still talk to standard nodes, see [moons](roots).
Roots require stable IP addresses.