Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 1.46 KB

docker-quickstart.md

File metadata and controls

40 lines (29 loc) · 1.46 KB

Docker-Compose Quick start

If you know how to use docker-compose, the following is the quickest way to set up the whole common-proxies, caddy/traefik stack.

  1. Download the desired docker-compose.yml in a new directory.

    • for caddy - simple to use if common-proxies is all you're running
    • or traefik - integrated with docker, extensible configuration
  2. Save one of the following files to .env in the same directory.

    If HTTPS is needed and the ports 443 and 80 are unused: Change the domain to yours.

    DOMAIN=mydomain.example.com
    LISTEN_DOMAIN="http://${DOMAIN} https://${DOMAIN}"
    HTTP=80
    HTTPS=443

    If you have another reverse proxy doing TLS and have that running on ports 80 and 443: Point them to localhost:5135 or change the port to one of your choice.

    DOMAIN=""
    LISTEN_DOMAIN="http://${DOMAIN}"
    HTTP=127.0.0.1:5135
    HTTPS=127.0.0.1:0 # essentially disables it

    Traefik setup needs one more variable for the automatic certificate negotiation:

    SSL_EMAIL=your-expiry-notification-email@example.org

    These two are just basic configurations, things can be modified for more custom needs.

  3. Run docker-compose up -d in that directory.

The linked docker compose file can be modified to suite your needs. Other environment variable configuration options are available in config.md.