add traefik config example

This commit is contained in:
Xenion1987
2023-04-25 12:39:11 +02:00
parent 15aefa698b
commit c967aaccf4
10 changed files with 272 additions and 44 deletions

33
config/traefik/README.md Normal file
View File

@@ -0,0 +1,33 @@
# Docker for [Invoice Ninja](https://www.invoiceninja.com/) using [Traefik proxy](https://doc.traefik.io/traefik/)
## Why use Traefik Proxy
Traefik is an open-source Edge Router that makes publishing your services a fun and easy experience. It receives requests on behalf of your system and finds out which components are responsible for handling them.
What sets Traefik apart, besides its many features, is that it automatically discovers the right configuration for your services. The magic happens when Traefik inspects your infrastructure, where it finds relevant information and discovers which service serves which request.
Traefik in combination with [Cloudflare](https://cloudflare.com) receives and serves all SSL certificates for each service domain automaticly by issuing a wildcard SSL certificate.
## Requirements
1. A domain using the Cloudflare nameservers [Cloudflare Docs](https://developers.cloudflare.com/registrar/get-started/transfer-domain-to-cloudflare/)
1. An API token with at least the following permissions: `Zone:Read, Zone Settings:Read, DNS:Edit` [Cloudflare Docs](https://developers.cloudflare.com/fundamentals/api/)
## Usage
1. Copy the [docker-compose.override.yml](./docker-compose.override.yml) to the repositorie's root directory
1. Set the Traefik proxy vars in the [env](../../env) file
1. Update the basic-auth username and password in [dynamic.yml](./config/dynamic.yml)
1. Start the docker compose stack
A few seconds later, you should be able to visit `https://${APP_URL_DOMAIN}:8080/dashboard/` and should be prompted for a username and password. If you have not changed it, it should be `username` and `EncryptedPassword`.
If there are no errors listed, you should be able to visit InvoiceNinja via `${APP_URL}`.
## Troubleshooting
If anything does not work as expected, consider checking Traefik's container logs via
```bash
docker compose logs -tf traefik
```

View File

@@ -0,0 +1,53 @@
tls:
options:
default:
minVersion: VersionTLS12
sniStrict: true
cipherSuites:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305
- TLS_AES_128_GCM_SHA256
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
curvePreferences:
- CurveP521
- CurveP384
http:
middlewares:
default:
chain:
middlewares:
- default-security-headers
- gzip
secHeaders:
chain:
middlewares:
- default-security-headers
- gzip
traefik-auth:
basicauth:
# Encrypt Password via 'echo $(htpasswd -nB username) | sed -e s/\\$/\\$\\$/g'
# Username: username
# Password: EncryptedPassword
users: username:$2y$05$lz9I2C9KoUdHwCOmPsKeBOU7EYMKMyzzCQs3KEmg4JZZL7ahLzjGO
default-security-headers:
headers:
browserXssFilter: true
contentTypeNosniff: true
forceSTSHeader: true
frameDeny: true
stsIncludeSubdomains: true
stsPreload: true
stsSeconds: 31536000
customFrameOptionsValue: "SAMEORIGIN"
referrerPolicy: "no-referrer"
customRequestHeaders:
X-Forwarded-Proto: "https"
gzip:
compress: {}

View File

@@ -0,0 +1,99 @@
version: "3.7"
services:
traefik:
image: traefik:latest
container_name: traefik
restart: unless-stopped
env_file: env
ports:
# Run traefik on port 80 and 443
# Feel free to modify depending what port is already occupied
- "80:80"
- "443:443"
# Run traefik dashboard on port 8080
# Feel free to modify depending what port is already occupied
- "8080:8080"
command:
# By default, the level is set to ERROR. Alternative logging levels are
# DEBUG, PANIC, FATAL, ERROR, WARN, and INFO.
- --log.level=ERROR
- --global.sendAnonymousUsage=false
# Enable Dashboard
- --api.insecure=false
- --api.dashboard=true
- --api.debug=true
# We are using Docker
- --providers.docker=true
- --providers.docker.exposedbydefault=false
# (Optional) Set default hostname if not given explicitly
- --providers.docker.defaultRule=Host(`${APP_URL_DOMAIN}`)
# Listen on port 80 (http)
- --entrypoints.web.address=:80
# Listen on port 443 (https)
- --entrypoints.websecure.address=:443
# Listen on port 8080 (traefik Dashboard)
- --entrypoints.traefik-dashboard.address=:8080
# Watch dynamic configuration file
- --providers.file.directory=/config
- --providers.file.watch=true
# Enable Access Log
- --accesslog.filepath=/var/log/www/access.log
# Automaticly redirect from http to https
- --entrypoints.web.http.redirections.entryPoint.to=websecure
- --entrypoints.web.http.redirections.entryPoint.scheme=https
################ START SSL configuration ################
# ---------> Cloudflare <---------
# DNS challenge via Cloudflare
- --certificatesresolvers.cloudflare.acme.email=${ACME_EMAIL}
- --certificatesresolvers.cloudflare.acme.storage=/ssl/acme.json
- --certificatesresolvers.cloudflare.acme.dnsChallenge.provider=cloudflare
- --certificatesresolvers.cloudflare.acme.dnsChallenge.delayBeforeCheck=60
- --certificatesresolvers.cloudflare.acme.dnsChallenge.resolvers=1.1.1.1:53
# (Optional) Use testing server before receiving the productive ssl certificate
#- --certificatesresolvers.cloudflare.acme.caServer=https://acme-staging-v02.api.letsencrypt.org/directory
- --entrypoints.websecure.http.tls.domains[0].main=${APP_URL_DOMAIN}
# (Optional) Use only, if you are able to receive a wildcard ssl certificate
# - --entrypoints.websecure.http.tls.domains[0].main=*.${CLOUDFLARE_DOMAIN}
# --------------------------------
################ END SSL configuration ################
volumes:
# So that Traefik can listen to the Docker events
- /var/run/docker.sock:/var/run/docker.sock:ro
# Dynamic configuration files
- ./config/traefik/config:/config
# Enable Access Log
- ./config/traefik/logs/:/var/log/www/
# LetsEncrypt Configuration Storage
- ./config/traefik/ssl:/ssl
labels:
# Enable Traefik
- traefik.enable=true
# Set Network to use
- traefik.docker.network=invoiceninja
# Load dynamic config
- traefik.http.routers.traefik-dashboard.middlewares=default@file
# Service related labels
- traefik.http.routers.traefik-dashboard.entrypoints=traefik-dashboard
- traefik.http.routers.traefik-dashboard.middlewares=traefik-auth@file
- traefik.http.routers.traefik-dashboard.service=api@internal
- traefik.http.routers.traefik-dashboard.tls=true
- traefik.http.routers.traefik-dashboard.tls.certResolver=cloudflare
- traefik.http.routers.traefik-dashboard.rule=Host(`${APP_URL_DOMAIN}`) && (PathPrefix(`/api`) || PathPrefix(`/dashboard`))
networks:
- invoiceninja
server:
labels:
# Enable Traefik
- "traefik.enable=true"
# Set Network to use
- "traefik.docker.network=invoiceninja"
# Load dynamic config
- "traefik.http.routers.ninja-nginx.middlewares=default@file"
# Service related labels
- "traefik.http.routers.ninja-nginx.entrypoints=websecure"
- "traefik.http.routers.ninja-nginx.tls=true"
- "traefik.http.routers.ninja-nginx.tls.certResolver=cloudflare"
- "traefik.http.routers.ninja-nginx.rule=Host(`${APP_URL_DOMAIN}`)"

View File

View File