Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
laduke committed Oct 10, 2023
1 parent 6d9e1e9 commit 4e90440
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
@@ -1,21 +1,27 @@
# configure zerotier nodes remotely
[![Node.js CI](https://github.com/laduke/joiner/actions/workflows/node.yml/badge.svg)](https://github.com/laduke/joiner/actions/workflows/node.yml)
Get a lists of zerotier networks from remote urls, join them, leave any other networks. Keep your device in sync without remembering all those network ids.

Get a list of zerotier networks from remote urls, join them, and leave any other networks. Keep your device in sync without remembering all those network ids.

The only flags now are --file, --url, --tokenPath

You can use multiple --file and --url flags at once.

- `npx @laduke/joiner --url http://example.com/work-networks.json --file ./home-networks.json --file test-networks.json`

- `./bin.js --url http://example.com/work-networks.json --file ./home-networks.json --file test-networks.json`
- `./bin.js --file ./none.json`
You can provide networks on stdin

- `echo "[{\"id\": \"1234123412341234\" }]" | npx @laduke/joiner`

See verbose more logs with env var

- `LOG_LEVEL=debug npx @laduke/joiner`

json format for now:

example.com/work-networks.json
``` json

example.com/work-networks.json
{
"networks": [{ "id": "2222222222222222", "allowDNS": true }, { "id": "4444444444444444" }]
}
Expand All @@ -27,15 +33,15 @@ example.com/work-networks.json
- [x] linter,formatter
- [x] refarcter
- [x] local file config
- [x] accept stdin
- [x] publish
- [ ] better error messages
- [ ] handle changed settings like `allowDNS`, only works right on first join
- [ ] logging
- [ ] containerize
- [ ] publish
- [x] accept stdin
- [ ] package for easy install
- [ ] more readme
- [ ] systemd timer service
- [ ] macos service
- [ ] figure out a better shape for the config data
- [ ] generate config from terraform output
- [ ] port to static language

0 comments on commit 4e90440

Please sign in to comment.