Options in settings.yml
Note: Having {{user}}
in the path tells Ansible to fill in the username automatically. You do not need to fill in your actual username.
-
nzbget
-
downloads
: Path for NZBGet downloads. Default is/mnt/local/downloads/nzbget
.
-
-
rutorrent
:-
downloads
: Path for ruTorrent downloads. Default is/mnt/local/downloads/rutorrent
.
-
-
plex
:-
tag
: Determines what version of Plex to install. Options arepublic
,beta
, or version tag (e.g."1.12.3.4973-215c28d86"
). Default ispublic
.-
Note 1: The
beta
tag (formerlyplexpass
) requires an active Plex Pass account. -
Note 2: Hardware Transcoding requires an active Plex Pass account.
-
Note 3: If you decide to change the tags later, you will need to update Plex by running the Cloudbox install command with the "plex" tag (i.e.
sudo ansible-playbook cloudbox.yml --tags plex
).
-
-
transcodes
: Path of temporary transcoding files. Default is"/home/{{user}}/transcodes"
.- Note: It is recommended to not use
/tmp
or/dev/shm
as a transcode location because the paths are cleared on reboots, causing Docker to create the folder as root and Plex transcoder to crash. Another reason why not to: https://forums.plex.tv/discussion/comment/1502936/#Comment_1502936.
- Note: It is recommended to not use
-
-
rclone
:-
version
: Rclone version that is installed by Cloudbox. Choices arelatest
or version number (e.g.1.42
). Default islatest
.
-
-
backup
:-
tar_dest
: Path for local backups (.tar). Only the most recent backup is kept. Default is/home/{{user}}/Backups
.- Note: Ensure the path does NOT have a trailing slash (
/
) or else backup will fail (i.e./sample/path
, but not/sample/path/
).
- Note: Ensure the path does NOT have a trailing slash (
-
rsync_dest
: Path for rsync backups (.tar). Only the most recent backup is kept.- Note: Ensure the path does NOT have a trailing slash (
/
) or else backup will fail (i.e./sample/path
, but not/sample/path/
).
- Note: Ensure the path does NOT have a trailing slash (
-
rclone_dest
: Path for cloud backups (e.g. Google Drive). Older backups are stored in thearchived
folder. Default isgoogle:/Backups
.- Note: Ensure the path does NOT have a trailing slash (
/
) or else backup "could" fail (i.e./sample/path
, but not/sample/path/
).
- Note: Ensure the path does NOT have a trailing slash (
-
keep_local_copy
: Option to save local copies of the backup file intar_dest
after backup is complete. Default istrue
. -
use_rsync
: Option to enable/disable rsync backups. Options aretrue
orfalse
. Default isfalse
. -
use_rclone
: Option to enable/disable cloud (i.e Google Drive) backups. Options aretrue
orfalse
. Default isfalse
. -
cron_time
: How often to backup should run (only whencron_state
is set topresent
). Options arereboot
,yearly
,annually
,weekly
,daily
, orhourly
. Default isweekly
.- Note: It is not recommended to schedule backups hourly as backing up may take a long time and cause future backup attempts to fail (the backup will not occur while another one is in progress, thanks to backup.lock file being created/removed during this process).
-
cron_state
: Option to enable/disable automatic backups. Options areabsent
orpresent
. Default isabsent
.-
absent
will remove any existing backup schedule. -
present
will ensure it is always scheduled. -
Note 1: Whenever this option is changed (e.g.
absent
topresent
;present
toabsent
), a manual backup (sudo ansible-playbook cloudbox.yml --tags backup
) must be run once in order to enable or disable the backup schedule. -
Note 2: This option just allows Cloudbox to schedule the backup for you. You can also setup scheduled backups by creating root cron tasks.
-
-
pushover_app_token
: Pushover App Token. Enables notifications to be sent when a backup task starts and finishes (requires both thepushover_app_token
and thepushover_user_key
). Default is blank. -
pushover_user_key
: Pushover User Key. Enables notifications to be sent when a backup task starts and finishes (requires both thepushover_app_token
and thepushover_user_key
). Default is blank.
-
- Overview
- Presumptions
- Server
- Domain Name
- Cloudflare
- Cloud Storage
- Plex / Emby - Account
- Usenet vs. BitTorrent
Cloudbox
- Overview
- Dependencies (Choose only one of these)
- Settings
- Preinstall (Choose only one of these)
- SSH
- Ansible Vault
- Rclone
- Cloudbox (Choose only one of these)
- Application Setup
- Next Steps
Feederbox (do this first)
- Overview
- Dependencies
- Settings
- Preinstall
- SSH
- Ansible Vault
- Rclone
- Feederbox (Choose only one of these)
- Application Setup
- Next Steps
Mediabox
- Overview
- Dependencies
- Settings
- Preinstall
- SSH
- Ansible Vault
- Rclone
- Mediabox (Choose only one of these)
- Application Setup
- Next Steps
- Cloudplow (Media Uploader)
- cb utility script (Develop branch only}
- Updating Cloudbox (Choose only one of these)
- Updating Cloudbox Apps
- Removing Cloudbox Apps
- Resetting Cloudbox Apps
- Migrating Cloudbox
- Settings Updater
- Ansible Vault Primer
- Plex Access Token
- Plex Autoscan Extras
- Pushover
- Google Drive API Client ID and Client Secret
- Useful Docker Commands
- Add Your Own Docker Container into Cloudbox
- Revoking SSL Certificates
- Feeder Mount
- Adding a Subdomain
- HTTP Auth Support
- Emby
- Nextcloud
- Resilio Sync
- Plex DupeFinder
- Heimdall
- NZBHydra v1
- Plex Requests
- Sickbeard MP4 Automator
- SABnzbd
- Traktarr
See Community Wiki.