zoraxydocker/zoraxy repository overview

⁠Zoraxy Docker

⁠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 \
  -e FASTGEOIP="true" \
  -e TZ="America/New_York" \
  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
    extra_hosts:
      - "host.docker.internal:host-gateway"
    environment:
      FASTGEOIP: "true"
      TZ: "America/New_York"

⁠Ports

⁠Volumes

⁠Extra Hosts

⁠Environment

Variables are the same as those in Start Parameters⁠.

⁠ZeroTier

If you are running with ZeroTier, make sure to add the following flags to ensure ZeroTier functionality:

--cap_add NET_ADMIN and --device /dev/net/tun:/dev/net/tun

Or for Docker Compose:

  cap_add:
    - NET_ADMIN
  devices:
    - /dev/net/tun:/dev/net/tun

⁠Plugins

Zoraxy includes a (experimental) store to download and use official plugins right from inside Zoraxy, no preparation required. For those looking to use custom plugins, build your plugins and place them inside the volume /path/to/zoraxy/plugin/:/opt/zoraxy/plugin/ (Adjust to your actual install location).

⁠Building

To build the Docker image:

• Check out the repository/branch.
• Copy the Zoraxy src/ 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.