Traefik3 docs changes. about docs HOT 25 OPEN

Also needed

• Authelia LDAP
• DB multi instance and notes on migration

from docs.

Add explanation about how to do var overrides for instances with dashes in the name.

Short explanation is that Ansible doesn't allow dashes (while it technically works anyway we're trying to avoid problems in the future in case it becomes enforced with default vars as well) in variable names so we're renaming the instance under the hood even if the folders, docker container/hostname, and the like still contains the dash in it the variable will replace dashes with underscores.

Opened traefik3 branch to start documenting branch-specific changes for post-merge.

41b63fc

from docs.

Explain media_server, download_clients and download_indexers roles and how to use them to change the apps installed by Saltbox, Mediabox and Feederbox tags.

#178

from docs.

traefik_tailscale_enabled: true # global toggle for tailscale entrypoint creation
traefik_traefik_tailscale_enabled: true # if you want dash to use tailscale
netdata_traefik_tailscale_enabled: true # role toggle
traefik_tailscale_bind_ip: "" # Set to override the WANIP port binding when server is not connected directly to the Internet.
traefik_tailscale_bind_ipv6: "" # Same but IPv6

#184

from docs.

Roles being moved from Sandbox to Saltbox

• autobrr
• dozzle
• unpackerr
• whisparr

from docs.

add warning about backup.yml changes for users of backup2. This change affects all users of backup now.

from docs.

I think we need a page dedicated to this migration/upgrade

from docs.

document restore_tar functionality to restore a single app

from docs.

document qbittorrent host install

from docs.

document backup_rclone_env

from docs.

qbittorrent will be the default torrent client

from docs.

document the legacy volume toggle

docker_legacy_volume: false

from docs.

document mounts_override

mounts_override: true

from docs.

document these toggles

skip_dns: false
role_dns_enabled: "{{ lookup('vars', role_name + '_dns_enabled', default=true) }}"

from docs.

document the traefik middleware var changes.

speedtest_traefik_sso_middleware: ""
speedtest_traefik_middleware_default: "{{ traefik_default_middleware }}"
speedtest_traefik_middleware_custom: ""

instead of

speedtest_traefik_middleware: "{{ traefik_default_middleware }}"

since inventory edits that try editing the old middleware var won't do anything anymore.

from docs.

document traefik API whitelisting change.

from docs.

document how to migrate databases from legacy installs to the new per app instance database format.

from docs.

add templates for external services to the advanced section, such as this

http:
  routers:
    ansible-http:
      entryPoints:
        - "web"
      rule: "Host(`ansible.saltbox.dev`)"
      middlewares:
        - globalHeaders
        - redirect-to-https@docker
        - gzip@docker
      service: "ansible"
    ansible:
      entryPoints:
        - "websecure"
      rule: "Host(`ansible.saltbox.dev`)"
      middlewares:
        - globalHeaders
        - secureHeaders
        - gzip@docker
      service: "ansible"
      tls:
        options: securetls@file
        certResolver: google
        domains:
          - main: "saltbox.dev"
            sans:
              - "*.saltbox.dev"
  services:
    ansible:
      loadBalancer:
        servers:
        - url: "http://172.19.0.1:8000"

from docs.

document the backup role template change in the config

from docs.

add set-backup/unset-backup crontab toggle explanation to the Traefik 3.0 upgrade explainer since it might confuse longtime users.
backup2 has set-backup2/unset-backup2 to toggle the crontab entry.

from docs.

maybe we should mention the rutorrent image change which means no more autodl?

from docs.

document the new way of toggling rclone remotes:

old way

---
downloads: /mnt/unionfs/downloads
transcodes: /mnt/local/transcodes
rclone:
  version: latest
  remote: 
shell: bash
authelia:
  master: yes
  subdomain: login

new way

---
authelia:
  master: yes
  subdomain: login
downloads: /mnt/unionfs/downloads
rclone:
  enabled: false <-- this
  remotes:
    - remote: google
      template: google
      vfs_cache:
        enabled: false
        max_age: 504h
        size: 50G
  version: latest
shell: bash
transcodes: /mnt/local/transcodes

Change was done to avoid having to redo the whole list structure in order to toggle deploying rclone remotes. The role will remove previously deployed Saltbox rclone services when disabled.

from docs.

Fix tag references on pages related to these two commits: saltyorg/Saltbox@571dfc1 saltyorg/Sandbox@19fac11

from docs.

add a section that explains the way to add custom Traefik routers and services using the YAML files.

from docs.

Document SABnzbd as default NZB client. Perhaps add docs on how to change clients if one desires.

from docs.