8000 zoraxy/docker at main · tobychui/zoraxy · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Latest commit

 

History

History

docker

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Dockerfile
Dockerfile
 
 
README.md
README.md
 
 
build_plugins.sh
build_plugins.sh
 
 
docker-compose.yml
docker-compose.yml
 
 
entrypoint.sh
entrypoint.sh
 
 

README.md

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/. 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 or a named Docker volume.

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 \
  --add-host=host.docker.internal:host-gateway \
  -p 80:80 \
  -p 443:443 \
  -p 8000:8000 \
  -v /path/to/zoraxy/config/:/opt/zoraxy/config/ \
  -v /path/to/zoraxy/plugin/:/opt/zoraxy/plugin/ \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /etc/localtime:/etc/localtime \
  -e FASTGEOIP="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/zoraxy/plugin/:/opt/zoraxy/plugin/
      - /var/run/docker.sock:/var/run/docker.sock
      - /etc/localtime:/etc/localtime
    extra_hosts:
      - "host.docker.internal:host-gateway"
    environment:
      FASTGEOIP: "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.
/opt/zoraxy/plugin/ Zoraxy plugins.
/var/run/docker.sock Docker socket. Used for additional functionality with Zoraxy.
/etc/localtime Localtime. Set to ensure the host and container are synchronized.

Extra Hosts

Host Details
host.docker.internal:host-gateway Resolves host.docker.internal to the host’s gateway IP on the Docker bridge network, allowing containers to access services running on the host machine.

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.
DB auto (String) Database backend to use (leveldb, boltdb, auto) Note that fsdb will be used on unsupported platforms like RISCV (default "auto").
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.
PLUGIN /opt/zoraxy/plugin/ (String) Set the path for Zoraxy plugins. Only change this if you know what you are doing.
PORT 8000 (Integer) 415E Management web interface listening port
SSHLB false (Boolean) Allow loopback web ssh connection (DANGER).
UPDATE_GEOIP false (Boolean) Download the latest GeoIP data and exit.
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.

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.

Plugins

You can find official plugins at https://github.com/aroz-online/zoraxy-official-plugins

Place your plugins inside the volume /path/to/zoraxy/plugin/:/opt/zoraxy/plugin/ (Adjust to your actual install location). Any plugins you have added will then be built and used on the next restart.

Important

Plugins are currently experimental.

Building

To build the Docker image:

  • Check out the repository/branch.
  • Copy the Zoraxy src/ and example/ directory into the docker/ (here) directory.
  • Run the build command with docker build -t zoraxy_build .
  • You can now use the image zoraxy_build
    • If you wish to change the image name, then modifyzoraxy_build in the previous step and then build again.
0