ZeroTierOne/netconf-service
2014-06-20 16:04:53 -07:00
..
config.js Simplify network briding modes -- we only need passive toggle and active bridge list, not three mode types. Also change isOpen to isPublic for terminology consistency. 2014-06-14 20:24:19 +00:00
index.js Don't list node as an active bridge if it's not authorized. (Wouldn't work anyway.) 2014-06-20 16:04:53 -07:00
netconf.service . 2014-05-21 02:48:58 +00:00
package.json Node redis module update. 2014-05-22 21:05:08 +00:00
README.md Yet more work on netconf master, add redis docs. 2014-05-07 02:45:15 +00:00
redis-schema.md Simplify network briding modes -- we only need passive toggle and active bridge list, not three mode types. Also change isOpen to isPublic for terminology consistency. 2014-06-14 20:24:19 +00:00

ZeroTier One Network Configuration Service Helper

This code will at the moment probably not be of much interest to end users. It's a "service," which is a sub-process that ZeroTier One can execute that provides additional functionaly not found in the core executable.

ZeroTier One communicates with services by sending and receiving string-serialized Dictionary objects terminated by an empty line for each Dictionary.

The netconf service, written in node.js and making use of the zerotier-idtool binary (see index.js) handles responding to virtual network config requests. It only runs on netconf masters. It fetches its configuration information from a Redis database.

The schama for that database is in redis-schema.txt. Some record types such as users will not be of interest to outside people. Pay attention to the network record type.

To install, copy the netconf-service folder to /var/lib/zerotier-one/services.d (create services.d first). Then run "npm install" from the netconf-service folder there and finally copy netconf.service to the parent services.d folder. Make sure that shell script is executable. This is what the ZeroTier One service will execute. It in turn sets up the node environment and runs index.js.

The utility zerotier-idtool must be present as /usr/local/bin/zerotier-idtool. This is hard coded for the moment. To get it build ZeroTier One from source and then "sudo cp zerotier-one /usr/local/bin/zerotier-idtool" (the binary determines its personality from argv[0] on execution).

Note: Windows builds of ZeroTier One do not support services. This code has only been tested on Linux but will probably work on Mac too.

Adam Ierymenko @ ZeroTier