ExternalVendorCode/ZeroTierOne
1
0
Fork 0
mirror of https://github.com/zerotier/ZeroTierOne.git synced 2025-04-07 11:17:29 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Adam Ierymenko 2013-10-03 15:48:26 -04:00
parent bb4a96c630
commit 0ab7b6d014
3 changed files with 30 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
AUTHORS.txt
View File

@ -4,19 +4,18 @@ contributors can be found on the GitHub home page at:
https://github.com/zerotier/ZeroTierOne
ZeroTier One includes or links with the following third party software:
ZeroTier One includes the following third party code:
* LZ4 compression algorithm by Yann Collet (BSD license)
http://code.google.com/p/lz4/
* OpenSSL libcrypto (BSD-style OpenSSL license)
http://www.openssl.org/
* TunTapOSX by Mattias Nissler (with tiny modifications) (BSD license)
* TunTapOSX by Mattias Nissler (forked for ZT1) (BSD license)
http://tuntaposx.sourceforge.net
* tap-windows by the OpenVPN project (forked for ZT1) (GPL)
https://github.com/OpenVPN/tap-windows
* Salsa20 stream cipher by D. J. Bernstein (public domain)
http://cr.yp.to/snuffle.html
* Salsa20 stream cipher, Curve25519 elliptic curve cipher, Ed25519
digital signature algorithm, and Poly1305 MAC algorithm, all by
Daniel J. Bernstein (public domain)
http://cr.yp.to/

8
README.md
View File

@ -1,17 +1,19 @@
ZeroTier One
======
ZeroTier One creates flat virtual Ethernet networks of almost unlimited size. [Visit ZeroTier on the web](https://www.zerotier.com/) for more information.
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 code is presently in **ALPHA** testing. That means that the protocol spec may change in incompatible ways, and it certainly has bugs. Testers should "git pull," rebuild, and restart fairly often. If things mysteriously stop working, do that.
See BUILDING.txt and RUNNING.txt for instructions. It currently builds on Mac and Linux. A Windows port is well along the way to completion. Nice packages/installers and auto-update are coming when alpha transitions to beta.
See BUILDING.txt and RUNNING.txt for instructions. It currently builds 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.
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 bc8f9a8ee3000001'. 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.)
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.
ZeroTier One is licensed under the GNU General Public License version 3. You are free to use, modify, or redistribute it under the terms of that license. If you would like to embed ZeroTier One in a closed source product or create a closed source derivative product, contact ZeroTier Networks LLC.
Check out the [blog](http://blog.zerotier.com/) for announcements, in-depth articles, and related thoughts.
Follow the [ZeroTier blog](http://blog.zerotier.com/) for announcements, in-depth articles, and related stuff.
[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/59b2cbb9c154bf84bddb4b714402e548 "githalytics.com")](http://githalytics.com/zerotier/ZeroTierOne)

33
RUNNING.txt
View File

@ -1,6 +1,6 @@
Running ZeroTier One from a source build:
First build it -- see BUILDING.txt -- then...
-- MacOS
-- MacOS --
By convention, ZeroTier One will keep its state here on mac:
@ -20,13 +20,12 @@ If run with no options, it will use the default home directory above.
sudo ./zerotier-one &
Type "ifconfig" and look for the new interface, which should be called
"zt0." The strange IPv4 address it has is your "zero4" address. Visit
http://zerotier.net/ to check your connection.
Finally, join the Earth network (the big public LAN and the only net for now):
Kill it with something like:
sudo zerotier-cli join bc8f9a8ee3000001
sudo killall zerotier-one
Try pinging earth.zerotier.net and going to http://earth.zerotier.net/ in a
browser to see if you're online.
-- Linux
@ -34,19 +33,25 @@ On Linux, the default ZeroTier home is:
/var/lib/zerotier-one
We use the Linux native tap driver, so no special drivers are needed. Just
type:
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.
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.
Type ifconfig and you should see an interface like "zt0." Then try
http://zerotier.net or ping zerotier.net to check your connection.
Finally, join the Earth network (the big public LAN and the only net for now):
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
To run for manual testing, build the ZeroTierOne VS2012 project and run it
in an administrator-privileged command prompt window.
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.