RUNNING.txt 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. This guide is for those building and running from source. See BUILDING.txt
  2. first.
  3. The wiki at GitHub contains several pages that are probably also of interest:
  4. https://github.com/zerotier/ZeroTierOne/wiki
  5. --- MacOS
  6. On Mac, the default ZeroTier home is:
  7. /Library/Application Support/ZeroTier/One
  8. ZeroTier ships with a kernel extension for its own tap device, which it
  9. stores in the above directory. To install this, type:
  10. sudo make install-mac-tap
  11. This will create the ZeroTier One home above if it does not exist and install
  12. the kext there. Note that the kext must be owned by root:wheel. The make
  13. rule for install-mac-tap takes care of that.
  14. Next, simply run the binary. It must be run as root to open the tap device.
  15. If run with no options, it will use the default home directory above.
  16. sudo ./zerotier-one &
  17. --- LINUX
  18. On Linux, the default ZeroTier home is:
  19. /var/lib/zerotier-one
  20. Just type:
  21. sudo mkdir /var/lib/zerotier-one
  22. sudo ./zerotier-one &
  23. Your system must have the Linux tun/tap driver available (tun). All tested
  24. distributions so far ship with this driver as a module that will load
  25. automatically.
  26. UDP port 9993 must be open in your local firewall for this to work properly.
  27. How to do this varies by Linux distribution.
  28. - Opening port 9993 on Ubuntu
  29. Follow the Ubuntu documentation about UFW https://help.ubuntu.com/community/UFW
  30. Check if your UFW is active.
  31. sudo ufw status verbose
  32. If it is active, open UDP port 9993
  33. sudo ufw allow 9993/udp
  34. You should now be able to ping and browse earth.zerotier.net
  35. --- WINDOWS
  36. A windows port is in progress.
  37. --- ONCE IT'S RUNNING:
  38. To use the command line interface, see this guide:
  39. https://github.com/zerotier/ZeroTierOne/wiki/Command-Line-Interface
  40. If you want to test by joining the Earth network, try:
  41. sudo ./zerotier-cli join 8056c2e21c000001
  42. An interface called 'zt0' should appear and should get an IP address in
  43. the 28.0.0.0/7 range (28.* or 29.*) within a few seconds or so. Then try
  44. pinging earth.zerotier.net or navigating to http://earth.zerotier.net/ in
  45. a web browser.