Skip to content

Latest commit

 

History

History
154 lines (112 loc) · 5.08 KB

README.md

File metadata and controls

154 lines (112 loc) · 5.08 KB
Raw

Docker self-hosted homeserver

This is my personal repository of my docker services that I self-host on my Homeserver.

The services are deployed through a docker-compose file. The following services are now deployed:

Exposed services

  • Tiny Tiny RSS (8000)
  • Ryot (8001)
  • FreshRSS (8003)
  • Mealie (8004)
  • Homeassistant (8008)

Requests are routed and handled through Traefik reverse proxy.

DuckDNS is used as a dynamic DNS provider and the relative docker service is used to keep my IP address up to date so that my services are always reachable through my DuckDNS subdomain.

Let's Encrypt is used to secure the connection to these services through free valid SSL certificates. Let's Encrypt is integrated into Traefik, which makes managing the SSL certificate part much easier.

Internal services

  • Traefik Dashboard
  • Watchtower
  • Changedetection (8002)

Traefik dashboard is used to keep an eye on the state of routing and services.

Watchtower keeps all the containers (itself as well) up to date automatically. Makes use of Gotify to notify me when an update occurs.

Other

  • backup-volumes.sh => Backs up the services' volumes to MEGA. Volumes are encrypted first with gocryptfs and then uploaded through mega-cmd. Status of backups is controlled through shoutrrr notifications.

Bootstrapping

Once the repo has been cloned, you need to

  1. Copy and rename:

    • .env.example -> .env
    • backup-config.sh.example -> backup-config.sh

  2. Configure .env file according to comments

    If this project is contained in a folder whose name is not homeserver, NETWORK_NAME should be changed accordingly (e.g. <foldername_frontend>)

  3. On your router, open the ports specified in the .env file. Also open port 443: it's needed for Let's Encrypt SSL verification.

Restoring backups

If you want to restore some backups

  1. Login to mega with mega-login
  2. Get the folder you need with mega-get
  3. If you have encrypted stuff with gocryptfs, also pull the gocryptfs.diriv file and put it in the downloaded folder.
  4. Decrypt the files with gocryptfs -masterkey <master_key> <encrypted_folder> <plain_folder>
  5. Extract the archive you want with tar -xzvf <archive> -C <localfolder>

Service-specific actions

Upgrade postgres DB See https://josepostiga.com/2020/08/15/how-to-quickly-upgrade-postgresql-version-using-docker/

docker-compose.yml:

  version: "3"
  services:
  #  ttrss-db:
  #    image: postgres:13
  #    container_name: ttrss-db
  #    environment:
  #      - POSTGRES_USER=ttrss
  #      - POSTGRES_PASSWORD=ttrss
  #    volumes:
  #      - ~/volumes/ttrss-db:/var/lib/postgresql/data
  #    networks:
  #      - backend
  #    restart: unless-stopped
    pg14-db:
      image: postgres:latest
      container_name: ttrss-db
      environment:
        - POSTGRES_USER=ttrss
        - POSTGRES_PASSWORD=ttrss
      volumes:
        - ~/volumes/ttrss-db:/var/lib/postgresql/data
        - ~:/tmp
      networks:
        - backend
      restart: unless-stopped

  networks:
    backend:
      driver: bridge

Homeassistant Dynamc config file

The usecase here is when you are hosting homeassistant on another device of your network and you want to expose HA to the internet without having to deal with SSL certificates. You can use traefik to redirect the traffic to that host on the internal network.

The traefik setup requires using a dynamic configuration that is loaded inside the container through a mounted volume. This is the required configuration:

  http:
  routers:
    ha:
      rule: Host(`primate-traffic.duckdns.org`)
      entryPoints:
        - homeassistant
      middlewares:
        - secureRedirectHA
      service: ha
    ha-sec:
      tls:
        certResolver: le
      rule: Host(`primate-traffic.duckdns.org`)
      service: ha
      entryPoints:
        - homeassistant

  middlewares:
    secureRedirectHA:
      redirectScheme:
        scheme: https
        port: 8008

  services:
    ha:
      loadBalancer:
        servers:
          - url: http://homeassistant.lan:8123
        passHostHeader: true

Booting everything up

Before launching everything, open docker-compose.yml and:

  1. Uncomment --log.level=DEBUG on traefik service
  2. Uncomment --certificatesResolvers.le.acme.caServer=https://acme-staging-v02.api.letsencrypt.org/directory to use let's encrypt staging server
  3. Comment --certificatesResolvers.le.acme.caServer=https://acme-v02.api.letsencrypt.org/directory

Then launch docker-compose up -d (specify the services if you don't want to launch them all).

Everything is fine if:

  • You can accesss traefik dashboard to the port specified
  • You can access the services you ran at the url and ports specified over HTTPS
  • If you restored backups, you can see the data on your services.

If the above is good, undo the changes you've just done the docker-compose.yml file and launch docker-compose down && docker-compose up -d