diff --git a/BUILDING.txt b/BUILDING.txt index 5625afa9e..9ec53010e 100644 --- a/BUILDING.txt +++ b/BUILDING.txt @@ -8,21 +8,13 @@ do this eventually. -- Linux -make - -That's it. Add ZT_AUTO_UPDATE=1 to the make command line to build an -auto-update-enabled version that will update from ZeroTier's servers. -This is disabled by default since such a build will automatically -replace itself with our binary distributions. +Just type 'make'. You'll need gcc and g++ installed, but ZeroTier One requires +no other third party libraries beyond the standard libc, libstdc++, and libm. -- MacOS make -The same ZT_AUTO_UPDATE=1 option as Linux supports can be used here to -build an auto-update-enabled version. By default auto-updates are not -enabled. - If you are building ext/tap-mac you will need a different version of the OSX gcc compiler chain than what currently ships (clang). We've got a copy available here: diff --git a/README.md b/README.md index b6976200f..d466c8678 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,11 @@ ZeroTier One ZeroTier One creates flat virtual Ethernet networks of almost unlimited size. [Visit ZeroTier Networks on the web](https://www.zerotier.com/) for more information. -This project is now in beta, which means that major incompatible protocol shifts should now become considerably more rare. You should still update very often if you plan to use it. Binary packages with auto-update are coming very soon. - Follow the [ZeroTier blog](http://blog.zerotier.com/) and the [GitHub project](https://github.com/zerotier/ZeroTierOne) to stay up to date. -See BUILDING.txt and RUNNING.txt for instructions. It currently runs on Mac and Linux. A Windows port is well along the way to completion. If you're brave you can load the Visual Studio 2012 solution and play around. +Auto-updating binary packages that install easily [can be found here.](https://www.zerotier.com/downloads.html) If you want to build from source, clone this repository and see BUILDING.txt and RUNNING.txt. -Once you have it running you can join the Earth network -- a LAN for the planet -- by using the 'zerotier-cli' tool: 'sudo zerotier-cli join 8056c2e21c000001'. Right now Earth is the only network. Ability to create private networks, as well as some additional special-purpose public ones, will be coming soon. (Note: previous alpha versions auto-joined Earth, but since 0.5.0 it no longer does this.) +Once you are up and running, you can [create an account on the network control panel](https://www.zerotier.com/networks.html) if you want to create a private network or you can join [Earth](https://www.zerotier.com/earth.html) by running (on Linux and Mac) `sudo ./zerotier-cli join 8056c2e21c000001`. Note that this won't work if your firewall does not allow outbound UDP. It must allow two way UDP conversations on port 9993 at a minimum. diff --git a/RUNNING.txt b/RUNNING.txt index 4bfa47f86..b7ef89669 100644 --- a/RUNNING.txt +++ b/RUNNING.txt @@ -1,15 +1,19 @@ -First build it -- see BUILDING.txt -- then... +This guide is for those building and running from source. See BUILDING.txt +first. --- MacOS -- +The wiki at GitHub contains several pages that are probably also of interest: + https://github.com/zerotier/ZeroTierOne/wiki -By convention, ZeroTier One will keep its state here on mac: +--- MacOS + +On Mac, the default ZeroTier home is: /Library/Application Support/ZeroTier/One ZeroTier ships with a kernel extension for its own tap device, which it stores in the above directory. To install this, type: -sudo make -f Makefile.mac install-mac-tap +sudo make install-mac-tap 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 @@ -20,14 +24,7 @@ If run with no options, it will use the default home directory above. sudo ./zerotier-one & -Finally, join the Earth network (the big public LAN and the only net for now): - -sudo zerotier-cli join 8056c2e21c000001 - -Try pinging earth.zerotier.net and going to http://earth.zerotier.net/ in a -browser to see if you're online. - --- Linux +--- LINUX On Linux, the default ZeroTier home is: @@ -38,31 +35,14 @@ Just type: sudo mkdir /var/lib/zerotier-one sudo ./zerotier-one & -When run with no options, ZT1 uses its default home path on the current -platform. Note that ZT1 requires the Linux tap driver, so it must be -available in the kernel or as a module. In most Linux distributions it's -included out of the box and should just work. +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. -Finally, join the Earth network (the big public LAN and the only net for now): +UDP port 9993 must be open in your local firewall for this to work properly. +How to do this varies by Linux distribution. -sudo zerotier-cli join bc8f9a8ee3000001 - -Try pinging earth.zerotier.net and going to http://earth.zerotier.net/ in a -browser to see if you're online. - --- Windows - -Port in progress, and it's going to pretty much always be more painful to -build than *nix systems. Just wait for the binary release unless you're -brave, in which case you can load the VS2012 solution and play around. - --- Open UDP port 9993 - -As noted in README.md, to actually function properly, you need to open -UDP port 9993 in your firewall. Following are instructions to open UDP port -9993 for specific operating systems. - ---- Ubuntu (version 12.04 and possibly other versions, too) + - Opening port 9993 on Ubuntu Follow the Ubuntu documentation about UFW https://help.ubuntu.com/community/UFW @@ -76,3 +56,19 @@ sudo ufw allow 9993/udp You should now be able to ping and browse earth.zerotier.net +--- WINDOWS + +A windows port is in progress. + +--- ONCE IT'S RUNNING: + +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 + +An interface called 'zt0' should appear and should get an IP address in +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.