Skip to content

v3.0.0 - The Lighthouse 🗼

Latest

Choose a tag to compare

@jfroment jfroment released this 12 Oct 14:26
· 1 commit to master since this release

A new organization, made to be customized without ever conflicting with updates. Breaking changes, but the migration is automatic: read the V3 Migration Guide.

What's new?

New organization 🗂️

  • [config] New config.yaml format: default values of each service (Traefik rules, dependencies) are now in the service itself (services/<name>/service.yaml). You only write what you want to change, and a new defaults section applies a parameter to all rules. See the Configuration Guide.
  • [script] You never have to edit a file tracked by git anymore, so updates never conflict with your changes. See Your files and the files of the project.
    • Customize a bundled service with an override file (services/<name>/custom/compose.override.yaml), merged on top of the bundled one. See Customize a bundled service.
    • Traefik configuration files are now yours (services/traefik/custom/traefik.yaml, middlewares.yaml, tls.yaml), created from templates (*.sample.*) like .env or config.yaml.
    • The directory mounted in the Traefik container is now generated on each run (services/traefik/generated-config/): the script does not modify your traefik.yaml anymore when TRAEFIK_CUSTOM_ACME_RESOLVER is set.
  • [script] One directory per service: services/<name>/compose.yaml, with its default values (service.yaml), an optional rules.yaml (Traefik config file applied when the service is enabled) and its other configuration files.
  • [script] All your own additions are now in the custom directory of each service (services/<name>/custom/, ignored by git): your changes on a bundled service, your own services (no more customFile needed) and, for Traefik, your own rules (services/traefik/custom/rules/).
  • [config] .env.custom is replaced by one environment file per service (services/<name>/custom/service.env), without prefix on variables. Services which need or support variables provide a service.sample.env: your file is created from it when you enable the service, required variables (changeme) are checked and optional ones are commented. See Environment variables.
  • [script] New tools/sync-templates.sh script, called by run-seedbox.sh and init.sh: it creates your files from the templates and, when a template changes after an update, merges the change in your file (or warns you if it cannot). Use status and diff to see where you stand. See Templates.
  • [script] Files generated by the script are now in .seedbox/ (ignored by git) instead of services/generated/ and env/.
  • [script] The local-persist Docker plugin is not needed anymore: services mount the directories of HOST_CONFIG_PATH directly, at the same place as before. Nothing to install as root, and nothing to migrate. Media (torrents, downloads, documents) stay shared volumes defined in docker-compose.yaml, plain directories or NFS share.

New features ✨

  • [Traefik] New internalOnly parameter on rules: the service is only reachable from your private networks (internal-only middleware, to adapt in your middlewares.yaml).
  • [Traefik] Client certificates (mTLS): new mtls parameter on rules, to restrict a service to the devices which own a certificate you created. The script stops if a rule requires a certificate and no Certificate Authority is found. See VaulTLS and client certificates.
  • [Traefik] Static IP for a service: docker-compose.sample.yaml has a (commented) ipam block which keeps a part of the network for static IPs, so no other container can take them. See Static IP for a service.
  • [Traefik] Traefik is restarted by run-seedbox.sh when its static configuration (traefik.yaml) has changed.
  • [script] Dependencies between services are declared by services (requires in service.yaml) instead of being hard-coded in the script.
  • [config] config.yaml is now checked: the script stops on any unknown parameter, so a typo (interalOnly...) cannot silently leave a service unprotected. Parameters are described in a new config.schema.json, which also gives completion and validation in editors supporting YAML schemas. It is generated by the new tools/generate_schema.py.
  • [script] run-seedbox.sh can be called from any directory (cron, absolute path...).
  • [script] The script does not read .env on its own anymore: it asks Docker Compose for the values, so both always see the same ones (quotes, special characters...).
  • [script] The name of the Docker Compose project is now always seedbox instead of the name of the directory: the directory of the seedbox can be renamed or moved.
  • [script] Missing directories of services (in HOST_CONFIG_PATH) and of media volumes are created by the script, owned by the user of the containers (PUID and PGID) instead of root.
  • [Nextcloud] tools/init-setup-nextcloud.sh reads its variables from the environment files of mariadb and nextcloud.
  • [script] The installed version is saved in .seedbox/version, to make future migrations reliable.
  • [script] Clear error when the docker-compose file of a service does not exist.

New services 💫

All disabled by default in config.sample.yaml, except Seerr.

Bugfixes and improvements ⚙️

  • [Jackett] Fix: Jackett had access to the whole config directory and changed the owner of the files of all other services each time it started. It now only uses its own directory (same place as before, nothing to migrate).
  • [ntfy] Authentication is now enabled (login required, no anonymous access). Create your users with NTFY_AUTH_USERS in services/ntfy/custom/service.env. New persistent directory: $HOST_CONFIG_PATH/ntfy-auth.
  • [Netdata] Now runs in host network mode with more access to the host (processes, logs, disks) for complete metrics. As a consequence it is not exposed through Traefik anymore: use http://<your-server>:19999. Image tag is now latest instead of stable.
  • [Calibre] CALIBRE_PASSWORD variable is removed: it was not applied since v2.2 (and showed a warning on each run). Nothing changes: Calibre is still protected by the http authentication of its Traefik rule (httpAuth: true by default).
  • [FlareSolverr] Use nodriver driver.
  • [Traefik] The Docker socket is now mounted read-only in the Traefik container.
  • [Traefik] Security headers: deprecated options are replaced in the middlewares.yaml template (featurePolicy becomes permissionsPolicy, browserXssFilter is removed).
  • [Nextcloud] The container has no access to the whole config directory of the seedbox anymore (/seedbox-config).
  • [Tautulli] The container only sees the config directory of Plex (read-only, in /plex) instead of the whole config directory of the seedbox.
  • All services now use the unless-stopped restart policy: a container you stopped yourself is not started again when Docker restarts.
  • [init] init.sh does not create the Docker network anymore: it is created by Docker Compose.
  • Removed obsolete tools and guides: tools/legacy/, tools/wip/, tools/config-updater/ (v1 to v2 migration) and the Traefik v1 to v2 guide.
  • [Nextcloud] MariaDB is now enabled in the sample configuration, as Nextcloud requires it.
  • [init] Fix #68: local-persist driver is not installed anymore (see above).
  • [script] CHECK_FOR_OUTDATED_CONFIG variable is removed: you are now warned each time a sample file changes, and tools/sync-templates.sh diff shows you what changed.
  • [doc] New V3 Migration Guide, Netbird, VaulTLS, Dockhand, FileBrowser Quantum and Plex guides. Configuration Guide rewritten for the new organization.
  • Fix typos in .env.sample and broken links in README.md.

Upgrade notes ⚠️

  • ./run-seedbox.sh migrates your installation automatically (config.yaml, .env.custom, your own services and Traefik files). Your previous config.yaml, .env.custom and traefik/ directory are saved in .seedbox/backup/.
  • If you edited files tracked by git in services/ or traefik/, git pull will refuse to update them: see this section. Your changes in traefik/traefik.yaml and traefik/custom/*.yaml are not carried over: report them in services/traefik/custom/.
  • [Removed services] Overseerr, Readarr, Ombi, Homarr and Portainer are not bundled anymore: these projects are discontinued, or replaced here by another service. If one of them is enabled in your config.yaml, the script stops because its file does not exist anymore.
    • Replacements: Seerr for Overseerr and Ombi (rename overseerr to seerr, and see the Seerr migration guide to keep your data), Dockhand for Portainer, Homepage or Heimdall for Homarr.
    • Still need one of them? Keep it as your own service, in one command: see Removed services and Add your own service.
  • [Filebrowser] The original Filebrowser is discontinued (archived repository): the filebrowser service now runs FileBrowser Quantum. It is another application, so users, settings and shares are not migrated (your files are not affected). A password is now required for its admin user (services/filebrowser/custom/service.env, the script asks for it), its data is in $HOST_CONFIG_PATH/filebrowser-quantum and its default rule has no http authentication anymore, as the application has its own. See its documentation.
  • [Docker Compose] Docker Compose v2 (docker compose command, 2.27.2 or above) is now required. The DOCKER_COMPOSE_BINARY variable is removed and the old docker-compose binary is not supported anymore.
  • [Docker Compose] If the directory of your seedbox is not named seedbox, the new project name requires to remove and create all containers again (not their data): the script asks you before doing it. Set COMPOSE_PROJECT_NAME in your .env to keep the previous name instead. See the V3 Migration Guide.
  • [local-persist] Your docker-compose.yaml and your own services may still use volumes of the plugin: they keep working as long as it is installed, and the script lists them. See how to get rid of it.
  • [script] Unused Docker images and volumes are not removed anymore after each run, as it applied to the whole host and not only to the seedbox. Set DOCKER_PRUNE_AFTER_UPDATE=true in your .env to get the previous behaviour back.
  • [Traefik] Administration tools are private by default: the default rules of the Traefik dashboard and Dockhand now have internalOnly: true (like VaulTLS), so they are only reachable from your private networks. Write internalOnly: false on their rule in config.yaml to publish them. Installations migrated from v2 are not changed: the migration keeps your Traefik dashboard reachable as before, with an explicit internalOnly: false that you may want to remove.
  • [Plex] Its default Traefik rule is removed: Plex uses the network of the host, so Traefik cannot reach it by its name. Use the port 32400, or publish it on plex.yourdomain.com with Netbird: see Plex documentation. Rules you may have for plex in your config.yaml are kept by the migration.
  • [Traefik] HTTP to HTTPS redirection is now global (set on the entrypoint in traefik.yaml) instead of being a middleware on each rule, and generated rules only use the HTTPS entrypoint. httpOnly rules still work: see Disable HTTPS completely for the details. The redirect-to-https middleware, not needed anymore, is removed from middlewares.yaml: if your own Traefik rules use it, remove it from them or add it back in your file.
  • [Netdata] Its default Traefik rule is removed (see above). If your config.yaml has rules for netdata, remove them: they cannot reach it anymore.
  • [config] customFile is now relative to the directory of the service. Plex hardware transcoding file is now compose-hardware-transcoding.yaml (updated by the migration).
  • [NFS] The sample file moved from samples/docker-compose.sample.nfs.yaml to docker-compose.nfs.sample.yaml. samples/ directory does not exist anymore.
  • [ntfy] As authentication is now enabled, your clients and scripts must use a user or a token. The http authentication of Traefik is therefore disabled in its default rule (httpAuth: false), as both cannot be used together. The migration keeps httpAuth: true if you had it: remove it from your config.yaml.
  • [Nextcloud / Tautulli] If you used the config directory of the seedbox from these containers (/seedbox-config in Nextcloud, /logs in Tautulli), add the volume back with an override file (see Customize a bundled service). In Tautulli, the logs of Plex are now in /plex/Library/Application Support/Plex Media Server/Logs.