Skip to content

Latest commit

 

History

History
98 lines (80 loc) · 4.53 KB

README.md

File metadata and controls

98 lines (80 loc) · 4.53 KB
Raw

Zoraxy Docker

Repo Version Size Pulls

Usage

If you are attempting to access your service from outside your network, make sure to forward ports 80 and 443 to the Zoraxy host to allow web traffic. If you know how to do this, great! If not, find the manufacturer of your router and search on how to do that. There are too many to be listed here. Read more about it from whatismyip.

In the examples below, make sure to update /path/to/zoraxy/config/ with your actual path. If a path is not provided, a Docker volume will be created at the location but it is recommended to store the data at a defined host location.

Once setup, access the webui at http://<host-ip>:8000 to configure Zoraxy. Change the port in the URL if you changed the management port.

Docker Run

docker run -d \
  --name zoraxy \
  --restart unless-stopped \
  -p 80:80 \
  -p 443:443 \
  -p 8000:8000 \
  -v /path/to/zoraxy/config/:/opt/zoraxy/config/ \
  -v /path/to/zerotier/config/:/var/lib/zerotier-one/ \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /etc/localtime:/etc/localtime \
  -e FASTGEOIP="true" \
  -e ZEROTIER="true" \
  zoraxydocker/zoraxy:latest

Docker Compose

services:
  zoraxy:
    image: zoraxydocker/zoraxy:latest
    container_name: zoraxy
    restart: unless-stopped
    ports:
      - 80:80
      - 443:443
      - 8000:8000
    volumes:
      - /path/to/zoraxy/config/:/opt/zoraxy/config/
      - /path/to/zerotier/config/:/var/lib/zerotier-one/
      - /var/run/docker.sock:/var/run/docker.sock
      - /etc/localtime:/etc/localtime
    environment:
      FASTGEOIP: "true"
      ZEROTIER: "true"

Ports

Port Details
80 HTTP traffic.
443 HTTPS traffic.
8000 Management interface. Can be changed with the PORT env.

Volumes

Volume Details
/opt/zoraxy/config/ Zoraxy configuration.
/var/lib/zerotier-one/ ZeroTier configuration. Only required if you wish to use ZeroTier.
/var/run/docker.sock Docker socket. Used for additional functionality with Zoraxy.
/etc/localtime Localtime. Set to ensure the host and container are synchronized.

Environment

Variables are the same as those in Start Parameters.

Variable Default Details
AUTORENEW 86400 (Integer) ACME auto TLS/SSL certificate renew check interval.
CFGUPGRADE true (Boolean) Enable auto config upgrade if breaking change is detected.
DOCKER true (Boolean) Run Zoraxy in docker compatibility mode.
EARLYRENEW 30 (Integer) Number of days to early renew a soon expiring certificate.
FASTGEOIP false (Boolean) Enable high speed geoip lookup, require 1GB extra memory (Not recommend for low end devices).
MDNS true (Boolean) Enable mDNS scanner and transponder.
MDNSNAME '' (String) mDNS name, leave empty to use default (zoraxy_{node-uuid}.local).
NOAUTH false (Boolean) Disable authentication for management interface.
PORT 8000 (Integer) Management web interface listening port
SSHLB false (Boolean) Allow loopback web ssh connection (DANGER).
VERSION false (Boolean) Show version of this server.
WEBFM true (Boolean) Enable web file manager for static web server root folder.
WEBROOT ./www (String) Static web server root folder. Only allow change in start parameters.
ZEROTIER false (Boolean) Enable ZeroTier functionality for GAN.
ZTAUTH "" (String) ZeroTier authtoken for the local node.
ZTPORT 9993 (Integer) ZeroTier controller API port.

Important

Contrary to the Zoraxy README, Docker usage of the port flag should NOT include the colon. Ex: -e PORT="8000" for Docker run and PORT: "8000" for Docker compose.