Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/key-networks/ztncui-containerized
A Docker image that contains ZeroTier One and ztncui to set up a standalone ZeroTier network controller with a web user interface in a container.
https://github.com/key-networks/ztncui-containerized
Last synced: 10 days ago
JSON representation
A Docker image that contains ZeroTier One and ztncui to set up a standalone ZeroTier network controller with a web user interface in a container.
- Host: GitHub
- URL: https://github.com/key-networks/ztncui-containerized
- Owner: key-networks
- Created: 2018-01-11T09:03:39.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-21T09:32:13.000Z (almost 2 years ago)
- Last Synced: 2024-08-01T12:28:05.553Z (3 months ago)
- Language: Shell
- Size: 27.3 KB
- Stars: 417
- Watchers: 14
- Forks: 81
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ztncui-containerized
## ZeroTier network controller user interface in a Docker container
This is a Docker image that contains **[ZeroTier One](https://www.zerotier.com/download.shtml)** and **[ztncui](https://key-networks.com/ztncui)** to set up a **standalone ZeroTier network controller** with a web user interface in a container.
Follow us on [](https://twitter.com/key_networks)
## Note
The keynetworks/ztncui Docker image is now being build with https://github.com/key-networks/ztncui-aio - this repo is just being maintained for reference to documentation.
## Docker run
```shell
docker run --name ztncui -dp 3443:3443 keynetworks/ztncui
```
See below for a more secure way of running the container.
## Connect to the user interface
Open a web browser to `https://docker_host:3443` where docker_host is the hostname or IP address of the machine running the container.
## Password
The default username is **admin** and default password is **password**. It would be best practice to restrict access to port 3443 of docker_host to the IP address of your machine before running the container, so that nobody else can login before you do. You can do this as follows:
First assign your IP address to an environment variable, for example:
```shell
MYADDR=12.34.56.78
```
This is to allow you to execute the following two commands in one shot to minimise the chance of some nefarious character getting in before you do:
```shell
docker run --name ztncui -dp 3443:3443 keynetworks/ztncui && \
docker exec ztncui iptables -I INPUT -i eth0+ ! -s $MYADDR -p tcp --dport 3443 -j DROP
```
## Persist Data in volumes
If you want to persist the ZeroTier and ztncui data in volumes outside of the container, then use this approach:
First assign your IP address to an environment variable, for example:
```shell
MYADDR=12.34.56.78
```
Then, execute in one shot:
```shell
docker run -dp 3443:3443 --name ztncui --volume ztncui:/opt/key-networks/ztncui/etc/ \
--volume zt1:/var/lib/zerotier-one/ keynetworks/ztncui && \
docker exec ztncui iptables -I INPUT -i eth0+ ! -s $MYADDR -p tcp --dport 3443 -j DROP
```
## Copy volumes to another Docker host
For various reasons (controller backup, redundancy, etc), it is useful to be able to copy the zt1 and ztncui volumes from one Docker host to another.
To copy the volumes from host1 to host2, first stop the ztncui container on host1:
```shell
docker stop ztncui
```
To copy the ztncui volume from host1 to host2, execute the following on host1:
```shell
docker run --rm --volume ztncui:/from alpine ash -c "cd /from ; tar -cf - . " | ssh user@host2 'docker run --rm -i --volume ztncui:/to alpine ash -c "cd /to ; tar -xpvf - " '
```
To copy the zt1 volume from host1 to host2, execute the following on host1:
```shell
docker run --rm --volume zt1:/from alpine ash -c "cd /from ; tar -cf - . " | ssh user@host2 'docker run --rm -i --volume zt1:/to alpine ash -c "cd /to ; tar -xpvf - " '
```
To run the container on host2:
```shell
docker run -dp 3443:3443 --name ztncui --volume ztncui:/opt/key-networks/ztncui/etc/ \
--volume zt1:/var/lib/zerotier-one/ keynetworks/ztncui
```
## Pass environment variables
As per https://github.com/key-networks/ztncui#summary-of-listening-states, environment variables can be passed with --env as of ztncui:1.2.2. Note that as of version 1.2.3 of the Docker image, passing `HTTP_ALL_INTERFACES=yes` will cause `HTTPS_PORT` to be ignored. Here is an example of how to pass environment variables:
```shell
docker run --env HTTP_PORT=8000 --env HTTP_ALL_INTERFACES=yes -dp 8000:8000 --name ztncui keynetworks/ztncui
```
Note that the above will expose HTTP on the docker host. This can be useful for offloading TLS to a proxy, but you should not expose HTTP directly to the Internet.
## Screenshots
Screenshots can be found at https://key-networks.com/ztncui#screenshots
## Usage
Usage is describe in `README.md` displayed at https://github.com/key-networks/ztncui
## Source Code
The source code for ztncui is at https://github.com/key-networks/ztncui
The source code for the docker image is in this repository.
## Feedback
Please give us your feedback. Please use the contact form at [key-networks.com](https://key-networks.com/).
## Bug and Vulnerability Reporting
Problems can be reported using the GitHub issue tracking system. Please use the contact form at [key-networks.com](https://key-networks.com/) to privately report potential vulnerabilities. Thank you.
## License
This is open source code, licensed under the GNU GPLv3, and is free to use on those terms. If you are interested in commercial licensing, please contact us via the contact form at [key-networks.com](https://key-networks.com) .
## Thanks
@flantel for contributing "Update exec.sh to allow override of HTTP_ variables from environment".
https://www.guidodiepen.nl/2016/05/transfer-docker-data-volume-to-another-host/ for command line for copying Docker volumes between machines.
@mark-stopka for contributing "Modify to enable TLS offload using Traefik".
@mdPlusPlus for clues on removing the requirement for --cap-add=NET_ADMIN and avoiding clashes with Ubuntu UIDs and GIDs.