diff options
author | Monty A <surgicalcoder@users.noreply.github.com> | 2017-07-07 10:11:21 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-07-07 10:11:21 +0100 |
commit | a274e774ee9299f168f6bf387a1182ae81bff045 (patch) | |
tree | 5c0203a44d0d5f7dfa39c70b69a5dfe71bc35bdc /controller/README.md | |
parent | 0ea1749c5986b5e8bc42de7951cd610ae448ec80 (diff) | |
download | infinitytier-a274e774ee9299f168f6bf387a1182ae81bff045.tar.gz infinitytier-a274e774ee9299f168f6bf387a1182ae81bff045.zip |
Clarification on how to use JSON API with secret
Makes it clear on how to use the authtoken.secret file when making requests.
Diffstat (limited to 'controller/README.md')
-rw-r--r-- | controller/README.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/controller/README.md b/controller/README.md index db8d0153..d70ffd2a 100644 --- a/controller/README.md +++ b/controller/README.md @@ -33,7 +33,7 @@ ZeroTier network controllers can easily be run in Docker or other container syst The controller API is hosted via the same JSON API endpoint that ZeroTier One uses for local control (usually at 127.0.0.1 port 9993). All controller options are routed under the `/controller` base path. -The controller microservice does not implement any fine-grained access control (authentication is via authtoken.secret just like the regular JSON API) or other complex mangement features. It just takes network and network member configurations and reponds to controller queries. We have an enterprise product called [ZeroTier Central](https://my.zerotier.com/) that we host as a service (and that companies can license to self-host) that does this. +The controller microservice does not implement any fine-grained access control (authentication is via authtoken.secret, simply append the value from authtoken.secret file, into a new querystring parameter named "auth" - for example `/controller/network?auth=6hdmozf8k5ds39kabcdefabc`) or other complex mangement features. It just takes network and network member configurations and reponds to controller queries. We have an enterprise product called [ZeroTier Central](https://my.zerotier.com/) that we host as a service (and that companies can license to self-host) that does this. All working network IDs on a controller must begin with the controller's ZeroTier address. The API will *allow* "foreign" networks to be added but the controller will have no way of doing anything with them since nobody will know to query it. (In the future we might support secondaries, which would make this relevant.) |