Portainer Templates logo

Portainer Templates

ZTNet ZTNet

Stack

NetworkingVPN

ZeroTier network controller with a web UI. Source: https://github.com/sinamics/ztnet

Source details

Repo: sinamics/ztnet
Stars: 1k
Forks: 116
Language: TypeScript
License: GPL-3.0
Latest: v0.8.3 · 21 days ago
Updated: 33 minutes ago
Website: ztnet.network/

Configuration

Type
Compose
Platform
linux
Env vars
NEXTAUTH_URL=http://localhost:3000NEXTAUTH_SECRET=changeme-generate-a-long-random-secret
Source
Repo

Source

Services

postgres

Configuration

Image
postgres:15.2-alpine
Volumes
/var/lib/postgresql/data : postgres-data
Env vars
POSTGRES_USER=postgresPOSTGRES_PASSWORD=postgresPOSTGRES_DB=ztnet
Restart
unless-stopped

Image details

Pulls: 11.2B
User: stackbrew
Created: Jun 05, 2014
Updated: 1 hour ago
Status: active

zerotier

Configuration

Image
zyclonite/zerotier:1.14.2
Ports
9993:9993/udp
Volumes
/var/lib/zerotier-one : zerotier
Env vars
ZT_OVERRIDE_LOCAL_CONF=trueZT_ALLOW_MANAGEMENT_FROM=172.31.255.0/29
Restart
unless-stopped

Image details

Pulls: 1.8M
User: zyclonite
Created: Jun 02, 2018
Updated: 2 months ago
Status: active

ztnet

Configuration

Image
sinamics/ztnet:latest
Ports
3000:3000
Volumes
/var/lib/zerotier-one : zerotier
Env vars
POSTGRES_HOST=postgresPOSTGRES_PORT=5432POSTGRES_USER=postgresPOSTGRES_PASSWORD=postgresPOSTGRES_DB=ztnetNEXTAUTH_URL=${NEXTAUTH_URL:-http://localhost:3000}NEXTAUTH_SECRET=${NEXTAUTH_SECRET:-changeme-generate-a-long-random-secret}NEXTAUTH_URL_INTERNAL=http://ztnet:3000
Restart
unless-stopped

Image details

Pulls: 267k
User: sinamics
Created: Jul 28, 2023
Updated: 3 days ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying ZTNet

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select ZTNet, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

---
volumes:
  zerotier:
  postgres-data:

networks:
  app-network:
    driver: bridge
    ipam:
      driver: default
      config:
        - subnet: 172.31.255.0/29

services:
  postgres:
    image: postgres:15.2-alpine
    restart: unless-stopped
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: postgres
      POSTGRES_DB: ztnet
    volumes:
      - postgres-data:/var/lib/postgresql/data
    networks:
      - app-network
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U postgres -d ztnet"]
      interval: 10s
      timeout: 5s
      retries: 5

  zerotier:
    image: zyclonite/zerotier:1.14.2
    hostname: zerotier
    restart: unless-stopped
    volumes:
      - zerotier:/var/lib/zerotier-one
    cap_add:
      - NET_ADMIN
      - SYS_ADMIN
    devices:
      - /dev/net/tun:/dev/net/tun
    networks:
      - app-network
    ports:
      - "9993:9993/udp"
    environment:
      - ZT_OVERRIDE_LOCAL_CONF=true
      - ZT_ALLOW_MANAGEMENT_FROM=172.31.255.0/29

  ztnet:
    image: sinamics/ztnet:latest
    working_dir: /app
    volumes:
      - zerotier:/var/lib/zerotier-one
    restart: unless-stopped
    ports:
      - "3000:3000"
    environment:
      POSTGRES_HOST: postgres
      POSTGRES_PORT: 5432
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: postgres
      POSTGRES_DB: ztnet
      # Public URL you reach the web UI on. Set to http://<your-host-ip>:3000
      NEXTAUTH_URL: ${NEXTAUTH_URL:-http://localhost:3000}
      # Strong random string — used to sign session tokens
      NEXTAUTH_SECRET: ${NEXTAUTH_SECRET:-changeme-generate-a-long-random-secret}
      # Internal URL for the 'ztnet' service. Do not change unless renaming the service.
      NEXTAUTH_URL_INTERNAL: "http://ztnet:3000"
    networks:
      - app-network
    depends_on:
      postgres:
        condition: service_healthy
      zerotier:
        condition: service_started

Or deploy it directly from the source:

git clone https://github.com/lissy93/portainer-templates
cd portainer-templates
docker compose -f sources/stacks/ztnet/docker-compose.yml up -d

More install options in our documentation, or see sinamics/ztnet for app-specific guidance.

Container Documentation

postgres Documentation

The PostgreSQL object-relational database system provides reliability and data integrity.

zerotier Documentation

ZeroTier One for container-oriented distributions like CoreOS (multi-arch support)

ztnet Documentation

ZTNET - Zerotier Controller Web UI

Serve ZTNet on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying ztnet.example.com to http://ztnet:3000

Add this to your Caddyfile

ztnet.example.com {
	reverse_proxy http://ztnet:3000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:9993 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :9993
  • Stop the other service, or pick a different host port. In 9993:9993 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:3000. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, ztnet can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 3000

Image won't pull

Test the pull directly on the host: docker pull postgres:15.2-alpine

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

ZTNet is a Compose stack, a set of containers (3 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 3 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • postgres runs postgres:15.2-alpine
  • zerotier runs zyclonite/zerotier:1.14.2
  • ztnet runs sinamics/ztnet:latest, starts after postgres, zerotier

Ports

A port is the door the app answers on. A mapping like 9993:9993 means it's reachable on port 9993 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:3000 in a browser. It opens:

  • 9993:9993 over UDP
  • 3000:3000, likely the web interface

Volumes

A volume is where ZTNet keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/lib/postgresql/data kept in the postgres-data volume Docker manages
  • /var/lib/zerotier-one kept in the zerotier volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. ZTNet takes 10 of them, all with defaults you can leave alone or tweak:

  • POSTGRES_USER, defaults to postgres
  • POSTGRES_PASSWORD, defaults to postgres
  • POSTGRES_DB, defaults to ztnet
  • ZT_OVERRIDE_LOCAL_CONF, defaults to true
  • ZT_ALLOW_MANAGEMENT_FROM, defaults to 172.31.255.0/29
  • POSTGRES_HOST, defaults to postgres
  • POSTGRES_PORT, defaults to 5432
  • NEXTAUTH_URL, defaults to http://localhost:3000
  • NEXTAUTH_SECRET, defaults to changeme-generate-a-long-random-secret
  • NEXTAUTH_URL_INTERNAL, defaults to http://ztnet:3000

Restart policy

The restart policy here is unless-stopped, so Docker restarts ZTNet after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like postgres) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

ZTNet is open source, released under the GPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set ZTNet up. Add the template list to Portainer once, then deploying ZTNet is a click rather than a wall of config.