wallenstein/ztncui
1
0
Fork 0
mirror of https://github.com/key-networks/ztncui.git synced 2025-06-07 10:43:44 +02:00
Code Issues Projects Releases Wiki Activity

issue#91: Update README.md with new instruction for authtoken.secret for zerotier-one 1.10.4 onwards

Browse source
This commit is contained in:
Key Networks 2023-03-11 16:39:16 +08:00
parent 3915b24b62
commit c366d25d40
1 changed files with 12 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -10,7 +10,7 @@ Follow us on [![alt @key_networks on Twitter](https://i.imgur.com/wWzX9uB.png)](
Instructions for installing on Linux from RPM or DEB packges are available at [key-networks.com/ztncui](https://key-networks.com/ztncui). Instructions for installing on Linux from RPM or DEB packges are available at [key-networks.com/ztncui](https://key-networks.com/ztncui).
## Docker Container Image ## Docker Container Image
See [github.com/key-networks/ztncui-containerized](https://github.com/key-networks/ztncui-containerized) See [https://github.com/key-networks/ztncui-aio](https://github.com/key-networks/ztncui-aio)
## Getting Started ## Getting Started
@ -45,21 +45,9 @@ npm install
##### 3. authtoken.secret ##### 3. authtoken.secret
The app needs to know the zerotier-one authtoken.secret. There are two options: The app needs to know the zerotier-one authtoken.secret.
###### A: Allow access to /var/lib/zerotier-one/authtoken.secret ###### Make a .env file
The user running the ztncui app needs read access to authtoken.secret. This can be achieved with:
```shell
sudo usermod -aG zerotier-one username
sudo chmod g+r /var/lib/zerotier-one/authtoken.secret
```
Where:
* username is the user running the ztncui app
Note that you need to log out and in again to apply the new group membership.
###### OR
###### B: Make a .env file
In the root of the ztncui directory, create a `.env` file with the content: In the root of the ztncui directory, create a `.env` file with the content:
``` ```
ZT_TOKEN=######################## ZT_TOKEN=########################
@ -67,17 +55,19 @@ ZT_TOKEN=########################
Where: Where:
* ######################## is the token string. * ######################## is the token string.
You can also specify in the `.env` file a different address for the zerotier-one API (which defaults to localhost:9993): After all edits to the `.env file` (see other options below), make the `.env` readable by the user running ztncui only:
```shell
chmod 400 .env
chown ztncui.ztncui .env
```
##### 4. Zerotier-one API port
You can specify in the `.env` file a different address for the zerotier-one API (which defaults to localhost:9993):
``` ```
ZT_ADDR=localhost:9995 ZT_ADDR=localhost:9995
``` ```
Make `.env` readable by the user running ztncui only:
```shell
chmod 600 .env
```
The `.env` file should make it easier to run ztncui on a non-Linux platform.
##### 4. Run in production mode ##### 4. Run in production mode
To run the server in production mode, add the following to the `.env` file (see 3B above): To run the server in production mode, add the following to the `.env` file (see 3B above):