My home Gateway setup

The setup is based on Traefik

Features

🔐 Automatically generates TLS certificates using LetsEncrypt 🔐
🪄 Automatically adds labeled docker containers🪄

How to use

Configuration

# The domain for the traefik dashboard
DOMAIN=traefik.domain.com
# Read Basic http auth section for details
HASHED_ADMIN_USER_PASS=username:password
# Email for LetsEncrypt
LE_EMAIL=yourletsencrypt@email.com

Shared network

In order to route traffic, the gateway must be in the same docker network as the target services.

For this I use external network:

docker network create mynetwork

Then add the network to the gateway service with the following configuration:

services:
  traefik:
    ...
    networks:
      - mynetwork


networks:
  mynetwork:
    external: true

Docker labels

...
services:
  <service name>:
    ...
    labels:
      - traefik.enable=true

      - traefik.http.middlewares.frontend.basicAuth.users=${HASHED_ADMIN_USER_PASS}
      - traefik.http.routers.<service name>.tls=true
      - traefik.http.routers.<service name>.tls.certresolver=le
      - traefik.http.routers.<service name>.tls.domains[0].main=${DOMAIN}
      - traefik.http.routers.<service name>.rule=Host(`${DOMAIN}`)
      - traefik.http.routers.<service name>.service=<service name>
      - traefik.http.services.<service name>loadbalancer.server.port=5080
      - traefik.http.routers.<service name>.middlewares=frontend

Basic http auth

Generate HASHED_ADMIN_USER_PASS using below command

htpasswd -B -C 10 -c .htpasswd user1
cat .htpasswd | sed -e s/\\$/\\$\\$/g

Example

With this you can expose Treafik dashboard with basic auth on a subdomain

labels:
  - traefik.enable=true
  - traefik.http.routers.traefik.rule=Host(`sub.${DOMAIN}`)
  - traefik.http.routers.traefik.tls=true
  - traefik.http.routers.traefik.tls.certresolver=le
  - traefik.http.routers.traefik.service=api@internal
  - traefik.http.services.api.loadbalancer.server.port=8080
  - traefik.http.routers.traefik.tls.domains[0].main=sub.${DOMAIN}
  - traefik.http.routers.traefik.middlewares=frontend
  - traefik.http.middlewares.frontend.basicAuth.users=${HASHED_ADMIN_USER_PASS}

DDNS

For DDNS I use this

version: "3.9"

include:
  - path: ../ddns/docker-compose.yml

services: ...

8tomat8/home-gateway