mirror of https://github.com/tobychui/zoraxy.git synced 2025-06-27 01:41:44 +02:00

Table of Contents

On this Page you find answers to often asked questions. If you do not find the information you need, or you have a specific question, then feel free to open a discussion. You found a bug? Then please write an issue with detailed informations!

Is there a docker image available?
Create a systemd-service for Zoraxy
Logrotation

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

On this Page you find answers to often asked questions. If you do not find the information you need, or you have a specific question, then feel free to open a discussion. You found a bug? Then please write an issue with detailed informations!

Is there a docker image available?

Yes a docker image is provided by passivelemmon, you can find more information in the docker readme!

Here is an example docker-compose.yml:


services:
  zoraxy:
    image: zoraxydocker/zoraxy:latest
    container_name: zoraxy
    restart: unless-stopped

    ports:
      - 80:80
      - 443:443
      - 8005:8000/tcp

     volumes:
       - ./config:/opt/zoraxy/config/
       - /var/run/docker.sock:/var/run/docker.sock

     environment:
       PORT: "8000"
       FASTGEOIP: "true"

Create a systemd-service for Zoraxy

If you want faster GeoIP-Lookup, you can add -fastgeoip=true after -port=:8000. Zoraxy will then use more RAM. See v2.6.6 Release

Create systemd-service file with

sudo nano /etc/systemd/system/zoraxy.service

Put in following lines:

[Unit]
Description=Zoraxy Reverse Proxy Server
After=network-online.target
Wants=network-online.target

[Service]
Type=simple

# root is needed here, since Zoraxy uses ports < 1000 and doing network stuff

User=root
Group=root

# Change the paths according to your needs!

WorkingDirectory=/directory/containing/zoraxy
ExecStart=/path/to/zoraxy_linux_amd64 -port=:8400 -fastgeoip=true

[Install]
WantedBy=multi-user.target

Start automaticly Zoraxy with:

sudo systemctl enable --now zoraxy

Now status messages can be showed with:

sudo systemctl status zoraxy

Source: https://github.com/tobychui/zoraxy/issues/8

Logrotation

Zoraxy logs can become big, depending on the usage and traffic.

Let´s create a logrotation rule for it!

sudo nano /etc/logrotate.d/zoraxy

Change the path to the directory containing Zoraxy logs (full path)

/path/to/the/zoraxy/log/*.log {
    daily
    missingok
    rotate 7
    compress
    delaycompress
    notifempty
}

"daily" means daily execution

"missingok" ignore if no log files existing

"rotate 7" keep old log files for 7 days

"compress" compress log files (log.gz)

"delaycompress" waits a little bit before compressing the first file to avoid data loss

"notifempty" ignores empty files

Run and test with:

sudo logrotate -d /etc/logrotate.d/zoraxy