|
@@ -13,6 +13,17 @@ Thanks to @kmahyyg for https://github.com/kmahyyg/ztncui-aio from which this bui
|
|
|
## Further information
|
|
|
Refer to https://github.com/key-networks/ztncui-containerized for the original documentation.
|
|
|
|
|
|
+## Build yourself
|
|
|
+
|
|
|
+```bash
|
|
|
+$ git clone https://github.com/key-networks/ztncui-aio
|
|
|
+$ docker build . -t keynetworks/ztncui:latest
|
|
|
+```
|
|
|
+
|
|
|
+Change `NODEJS_MAJOR` variable in Dockerfile to use different nodejs version.
|
|
|
+
|
|
|
+Never use `node_lts.x` as your installation script of nodejs whose version might changed without further notice due to time shift.
|
|
|
+
|
|
|
## Usage
|
|
|
|
|
|
```bash
|
|
@@ -26,6 +37,8 @@ $ docker run -d -p3443:3443 -p3180:3180 \
|
|
|
keynetworks/ztncui
|
|
|
```
|
|
|
|
|
|
+If their one is not updated, try `docker pull ghcr.io/kmahyyg/ztncui-aio:latest` ! (YES, We Love GitHub!)
|
|
|
+
|
|
|
## Supported Configuration via persistent storage
|
|
|
|
|
|
For ZTNCUI: https://github.com/key-networks/ztncui
|
|
@@ -36,7 +49,7 @@ For ZTNCUI: https://github.com/key-networks/ztncui
|
|
|
| no | HTTPS_HOST | Only Listen on HTTPS_HOST:HTTPS_PORT | NO DEFAULT |
|
|
|
| no | HTTPS_PORT | HTTPS_PORT | 3443 |
|
|
|
| no | HTTP_PORT | HTTP_PORT | 3000 |
|
|
|
-| no | HTTP_ALL_INTERFACES | Listen on all interfaces | NO DEFAULT |
|
|
|
+| no | HTTP_ALL_INTERFACES | Listen on all interfaces, useful for reverse proxy, HTTP only | NO DEFAULT |
|
|
|
|
|
|
This image additional specific:
|
|
|
|
|
@@ -49,3 +62,10 @@ This image additional specific:
|
|
|
Also, this image exposed an http server at port 3180, you could save file in `/mydata/ztncui/myfs/` to serve it. (You could use this to build your own root server and distribute planet file)
|
|
|
|
|
|
**WARNING: IF YOU DO NOT SET PASSWORD, YOU HAVE TO USE `docker exec -it <CONTAINER NAME> bash`, and then `cat /var/log/docker-ztncui.log` to get your random password. This is gatekeeper.**
|
|
|
+
|
|
|
+## Chinese users only
|
|
|
+
|
|
|
+This script use https:///ip.sb for public IP detection purpose, which is blocked in some area of China Mainland. Under this circumstance, the program will try to detect public IP using `ifconfig` tool and might lead to unwanted result, to prevent this, make sure you set `MYADDR` environment variable when docker container is up.
|
|
|
+
|
|
|
+The upstream repo (https://github.com/kmahyyg/ztncui-aio) only accept Issues and PRs in English. Other languages will be closed directly without any further notice. If you come from some non-English countries, use Google Translate, and state that at the beginning of the text body.
|
|
|
+
|