Repository navigation
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.yamlformat: 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 newdefaultssection 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.envorconfig.yaml. - The directory mounted in the Traefik container is now generated on each run (
services/traefik/generated-config/): the script does not modify yourtraefik.yamlanymore whenTRAEFIK_CUSTOM_ACME_RESOLVERis set.
- Customize a bundled service with an override file (
- [script] One directory per service:
services/<name>/compose.yaml, with its default values (service.yaml), an optionalrules.yaml(Traefik config file applied when the service is enabled) and its other configuration files. - [script] All your own additions are now in the
customdirectory of each service (services/<name>/custom/, ignored by git): your changes on a bundled service, your own services (no morecustomFileneeded) and, for Traefik, your own rules (services/traefik/custom/rules/). - [config]
.env.customis replaced by one environment file per service (services/<name>/custom/service.env), without prefix on variables. Services which need or support variables provide aservice.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.shscript, called byrun-seedbox.shandinit.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). Usestatusanddiffto see where you stand. See Templates. - [script] Files generated by the script are now in
.seedbox/(ignored by git) instead ofservices/generated/andenv/. - [script] The
local-persistDocker plugin is not needed anymore: services mount the directories ofHOST_CONFIG_PATHdirectly, at the same place as before. Nothing to install asroot, and nothing to migrate. Media (torrents,downloads,documents) stay shared volumes defined indocker-compose.yaml, plain directories or NFS share.
New features ✨
- [Traefik] New
internalOnlyparameter on rules: the service is only reachable from your private networks (internal-onlymiddleware, to adapt in yourmiddlewares.yaml). - [Traefik] Client certificates (mTLS): new
mtlsparameter 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.yamlhas a (commented)ipamblock 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.shwhen its static configuration (traefik.yaml) has changed. - [script] Dependencies between services are declared by services (
requiresinservice.yaml) instead of being hard-coded in the script. - [config]
config.yamlis now checked: the script stops on any unknown parameter, so a typo (interalOnly...) cannot silently leave a service unprotected. Parameters are described in a newconfig.schema.json, which also gives completion and validation in editors supporting YAML schemas. It is generated by the newtools/generate_schema.py. - [script]
run-seedbox.shcan be called from any directory (cron, absolute path...). - [script] The script does not read
.envon 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
seedboxinstead 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 (PUIDandPGID) instead ofroot. - [Nextcloud]
tools/init-setup-nextcloud.shreads its variables from the environment files ofmariadbandnextcloud. - [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.
Jellyfin: Media streamingSeerr: Content requests, which replaces Overseerr and OmbiActual Budget: Personal financeMealie: Recipes managerStirling PDFandBentoPDF: PDF toolsVaultwarden: Passwords managerVaulTLS: Client certificates management, see documentationFileBrowser Quantum: Files explorer, which replaces Filebrowser under the same service name (filebrowser), see documentationDockhand: Containers management, which replaces Portainer, see documentationWireguard: VPN serverNetbird: Mesh VPN and public reverse proxy with access control, with CrowdSec and automatic export of Traefik certificates (experimental, see documentation)
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_USERSinservices/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_PASSWORDvariable 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: trueby default). - [FlareSolverr] Use
nodriverdriver. - [Traefik] The Docker socket is now mounted read-only in the Traefik container.
- [Traefik] Security headers: deprecated options are replaced in the
middlewares.yamltemplate (featurePolicybecomespermissionsPolicy,browserXssFilteris 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-stoppedrestart policy: a container you stopped yourself is not started again when Docker restarts. - [init]
init.shdoes 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-persistdriver is not installed anymore (see above). - [script]
CHECK_FOR_OUTDATED_CONFIGvariable is removed: you are now warned each time a sample file changes, andtools/sync-templates.sh diffshows 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.sampleand broken links inREADME.md.
Upgrade notes ⚠️
./run-seedbox.shmigrates your installation automatically (config.yaml,.env.custom, your own services and Traefik files). Your previousconfig.yaml,.env.customandtraefik/directory are saved in.seedbox/backup/.- If you edited files tracked by git in
services/ortraefik/,git pullwill refuse to update them: see this section. Your changes intraefik/traefik.yamlandtraefik/custom/*.yamlare not carried over: report them inservices/traefik/custom/. - [Removed services]
Overseerr,Readarr,Ombi,HomarrandPortainerare not bundled anymore: these projects are discontinued, or replaced here by another service. If one of them is enabled in yourconfig.yaml, the script stops because its file does not exist anymore.- Replacements: Seerr for Overseerr and Ombi (rename
overseerrtoseerr, 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.
- Replacements: Seerr for Overseerr and Ombi (rename
- [Filebrowser] The original Filebrowser is discontinued (archived repository): the
filebrowserservice 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 itsadminuser (services/filebrowser/custom/service.env, the script asks for it), its data is in$HOST_CONFIG_PATH/filebrowser-quantumand its default rule has no http authentication anymore, as the application has its own. See its documentation. - [Docker Compose] Docker Compose v2 (
docker composecommand, 2.27.2 or above) is now required. TheDOCKER_COMPOSE_BINARYvariable is removed and the olddocker-composebinary 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. SetCOMPOSE_PROJECT_NAMEin your.envto keep the previous name instead. See the V3 Migration Guide. - [local-persist] Your
docker-compose.yamland 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=truein your.envto 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. WriteinternalOnly: falseon their rule inconfig.yamlto publish them. Installations migrated from v2 are not changed: the migration keeps your Traefik dashboard reachable as before, with an explicitinternalOnly: falsethat 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 onplex.yourdomain.comwith Netbird: see Plex documentation. Rules you may have forplexin yourconfig.yamlare 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.httpOnlyrules still work: see Disable HTTPS completely for the details. Theredirect-to-httpsmiddleware, not needed anymore, is removed frommiddlewares.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.yamlhas rules fornetdata, remove them: they cannot reach it anymore. - [config]
customFileis now relative to the directory of the service. Plex hardware transcoding file is nowcompose-hardware-transcoding.yaml(updated by the migration). - [NFS] The sample file moved from
samples/docker-compose.sample.nfs.yamltodocker-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 keepshttpAuth: trueif you had it: remove it from yourconfig.yaml. - [Nextcloud / Tautulli] If you used the config directory of the seedbox from these containers (
/seedbox-configin Nextcloud,/logsin 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.