docs
docs copied to clipboard
Traefik3 docs changes.
~~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.~~
Also needed
- [x] Authelia LDAP
- [x] DB multi instance and notes on migration
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.
https://github.com/saltyorg/docs/commit/41b63fc8df5b35fd497a7c791ab8d81dcb9950a4
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
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
Roles being moved from Sandbox to Saltbox
- autobrr
- dozzle
- unpackerr
- whisparr
add warning about backup.yml changes for users of backup2. This change affects all users of backup now.
I think we need a page dedicated to this migration/upgrade
document restore_tar functionality to restore a single app
document qbittorrent host install
document backup_rclone_env
qbittorrent will be the default torrent client
document the legacy volume toggle
docker_legacy_volume: false
document mounts_override
mounts_override: true
document these toggles
skip_dns: false
role_dns_enabled: "{{ lookup('vars', role_name + '_dns_enabled', default=true) }}"
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.
document traefik API whitelisting change.
document how to migrate databases from legacy installs to the new per app instance database format.
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"
document the backup role template change in the config
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.
maybe we should mention the rutorrent image change which means no more autodl?
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.
Fix tag references on pages related to these two commits: https://github.com/saltyorg/Saltbox/commit/571dfc125bc560299bfc89d3df6d9969bdc7a4e3 https://github.com/saltyorg/Sandbox/commit/19fac11ec6cb67752d8945fb29d580ef2c7ad11a
add a section that explains the way to add custom Traefik routers and services using the YAML files.
Document SABnzbd as default NZB client. Perhaps add docs on how to change clients if one desires.