Configurations

Basic Config File

Here's a simple example of a configuration file:

providers:
  docker:
    local: $DOCKER_HOST

Understanding the Config File

The config.yml file is divided into several sections:

• acl: Handles access control
• autocert: Handles SSL certificate settings
• entrypoint: Manages GoDoxy entrypoints (port 80 and 443)
  • middlewares: Defines middleware settings
  • access_log: Configures access logs
• providers: Sets up orchestrators This is required
  • include: Includes route configuration files
  • docker: Configures Docker providers
  • agents: GoDoxy agents
  • proxmox: Proxmox credentials
  • notification: Configures notifications for health monitoring
  • maxmind: MaxMind credentials
• match_domains: List of domains to match
• homepage: Configures homepage settings

Auto SSL and Domain matching

Specify which domains your application should respond to.

autocert:
  provider: cloudflare
  email: your-email@example.com
  domains:
    - *.yourdomain.com
match_domains:
  - yourdomain.com

See Certificates and domain matching

Entrypoint Configuration

This section defines how GoDoxy handles incoming requests.

entrypoint:
  middlewares:
    - use: CIDRWhitelist
      allow:
        - "127.0.0.1"
        - "10.0.0.0/8"
        - "192.168.0.0/16"
      status: 403
      message: "Forbidden"

  access_log:
    format: combined
    path: /app/logs/access.log
    filters: ...
    fields: ...

Setting Up Providers

providers:
  include:
    - file1.yml
    - file2.yml

  docker:
    local: $DOCKER_HOST
    remote-1: tcp://10.0.2.1:2375
    remote-2: ssh://root:1234@10.0.2.2

  agents:
    - 10.0.0.1:8899
    - 10.0.0.2:8899

  notification:
    - name: gotify
      provider: gotify
      url: https://gotify.example.com
      token: your-token

  proxmox:
    - url: https://pve.domain.com:8006/api2/json
      token_id: root@pam!abcdef
      secret: aaaa-bbbb-cccc-dddd
      no_tls_verify: true

  maxmind:
    account_id: 123456
    license_key: your-license-key
    database: geolite # or geoip2 if you have subscription

Homepage Settings

Configure how GoDoxy handles the WebUI App dashboard.

homepage:
  use_default_categories: true

See Homepage Configurations

Multi Docker Nodes Setup

Method 1: Using godoxy-agent (recommended)

How?

1. Create a directory for agent server, cd into it
2. Navigate to Metrics tab in Web UI, click Add agent, fill in required information then click Copy docker compose
3. Paste the docker compose into a file (e.g., compose.yml) on the agent server then start it with docker compose up -d

Why?

• godoxy-agent is a light-weight agent that handles docker, metrics and health checks
• Secure by default, with HTTPS and mTLS

Method 2: Using docker-socket-proxy

WARNING

Not recommended

This exposes docker socket and maintain unencrypted connection

run the following docker compose file on the other node:

docker-proxy:
  container_name: docker-proxy
  image: lscr.io/linuxserver/socket-proxy:latest
  environment:
    - ALLOW_START=1
    - ALLOW_STOP=1
    - ALLOW_RESTARTS=1
    - CONTAINERS=1
    - EVENTS=1
    - INFO=1
    - PING=1
    - POST=1
    - VERSION=1
  volumes:
    - /var/run/docker.sock:/var/run/docker.sock
  restart: always
  tmpfs:
    - /run
  ports:
    - <ip>:2375:2375

Add this to your config.yml under providers.docker:

providers:
  docker:
    local: $DOCKER_HOST
    server-1: tcp://<ip>:2375 # add it here