2014-12-19 23:18:20 +00:00
|
|
|
Running ZeroTier One
|
|
|
|
|
======
|
|
|
|
|
|
|
|
|
|
This guide is for those building and running from source. See BUILDING.md
|
2014-02-16 20:08:13 +00:00
|
|
|
first.
|
2013-07-04 20:56:19 +00:00
|
|
|
|
2014-02-16 20:08:13 +00:00
|
|
|
The wiki at GitHub contains several pages that are probably also of interest:
|
|
|
|
|
https://github.com/zerotier/ZeroTierOne/wiki
|
2013-07-04 20:56:19 +00:00
|
|
|
|
2014-12-19 23:18:20 +00:00
|
|
|
### MacOS
|
2014-02-16 20:08:13 +00:00
|
|
|
|
|
|
|
|
On Mac, the default ZeroTier home is:
|
2013-07-04 20:56:19 +00:00
|
|
|
|
|
|
|
|
/Library/Application Support/ZeroTier/One
|
|
|
|
|
|
|
|
|
|
ZeroTier ships with a kernel extension for its own tap device, which it
|
2013-10-28 19:18:06 +00:00
|
|
|
stores in the above directory. To install this, type:
|
2013-07-04 20:56:19 +00:00
|
|
|
|
2014-02-16 20:08:13 +00:00
|
|
|
sudo make install-mac-tap
|
2013-07-04 20:56:19 +00:00
|
|
|
|
|
|
|
|
This will create the ZeroTier One home above if it does not exist and install
|
|
|
|
|
the kext there. Note that the kext must be owned by root:wheel. The make
|
|
|
|
|
rule for install-mac-tap takes care of that.
|
|
|
|
|
|
|
|
|
|
Next, simply run the binary. It must be run as root to open the tap device.
|
2013-08-30 19:30:53 +00:00
|
|
|
If run with no options, it will use the default home directory above.
|
2013-07-04 20:56:19 +00:00
|
|
|
|
2013-08-30 19:30:53 +00:00
|
|
|
sudo ./zerotier-one &
|
2013-07-04 20:56:19 +00:00
|
|
|
|
2014-12-19 23:18:20 +00:00
|
|
|
### LINUX
|
2013-07-04 20:56:19 +00:00
|
|
|
|
|
|
|
|
On Linux, the default ZeroTier home is:
|
|
|
|
|
|
|
|
|
|
/var/lib/zerotier-one
|
|
|
|
|
|
2013-10-03 19:48:26 +00:00
|
|
|
Just type:
|
2013-07-04 20:56:19 +00:00
|
|
|
|
|
|
|
|
sudo mkdir /var/lib/zerotier-one
|
2013-08-30 19:30:53 +00:00
|
|
|
sudo ./zerotier-one &
|
|
|
|
|
|
2014-02-16 20:08:13 +00:00
|
|
|
Your system must have the Linux tun/tap driver available (tun). All tested
|
|
|
|
|
distributions so far ship with this driver as a module that will load
|
|
|
|
|
automatically.
|
2013-07-04 20:56:19 +00:00
|
|
|
|
2014-02-16 20:08:13 +00:00
|
|
|
UDP port 9993 must be open in your local firewall for this to work properly.
|
|
|
|
|
How to do this varies by Linux distribution.
|
2013-11-21 23:28:03 +00:00
|
|
|
|
2014-02-16 20:08:13 +00:00
|
|
|
- Opening port 9993 on Ubuntu
|
2013-11-21 23:28:03 +00:00
|
|
|
|
|
|
|
|
Follow the Ubuntu documentation about UFW https://help.ubuntu.com/community/UFW
|
|
|
|
|
|
|
|
|
|
Check if your UFW is active.
|
|
|
|
|
|
|
|
|
|
sudo ufw status verbose
|
|
|
|
|
|
|
|
|
|
If it is active, open UDP port 9993
|
|
|
|
|
|
|
|
|
|
sudo ufw allow 9993/udp
|
|
|
|
|
|
|
|
|
|
You should now be able to ping and browse earth.zerotier.net
|
|
|
|
|
|
2014-12-19 23:18:20 +00:00
|
|
|
### FreeBSD
|
|
|
|
|
|
|
|
|
|
FreeBSD is identical to Linux except that the default home is
|
|
|
|
|
/var/db/zerotier-one instead of /var/lib.
|
|
|
|
|
|
|
|
|
|
### WINDOWS
|
2014-02-16 20:08:13 +00:00
|
|
|
|
2014-12-19 23:18:20 +00:00
|
|
|
Run zerotier-one.exe -h for help. There's a command to install the current
|
|
|
|
|
binary as a service to run it that way, and another option to run it from
|
|
|
|
|
the Windows console.
|
2014-02-16 20:08:13 +00:00
|
|
|
|
2014-12-19 23:18:20 +00:00
|
|
|
### Once you're up and running...
|
2014-02-16 20:08:13 +00:00
|
|
|
|
|
|
|
|
To use the command line interface, see this guide:
|
|
|
|
|
https://github.com/zerotier/ZeroTierOne/wiki/Command-Line-Interface
|
|
|
|
|
|
|
|
|
|
If you want to test by joining the Earth network, try:
|
|
|
|
|
sudo ./zerotier-cli join 8056c2e21c000001
|
|
|
|
|
|
2014-12-19 23:18:20 +00:00
|
|
|
An interface called 'zt####' should appear and should get an IP address in
|
2014-02-16 20:08:13 +00:00
|
|
|
the 28.0.0.0/7 range (28.* or 29.*) within a few seconds or so. Then try
|
|
|
|
|
pinging earth.zerotier.net or navigating to http://earth.zerotier.net/ in
|
|
|
|
|
a web browser.
|
