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.

---

• downloads

  • nzbs: Path for Usenet app downloads (e.g. NZBGet). Default is /mnt/local/downloads/nzbs.

    • Example: NZBGet would download into /mnt/local/downloads/nzbs/nzbget/completed, where as, SABnzbd would go to /mnt/local/downloads/nzbs/sabnzbd/complete

  • torrents: Path for Torrent downloads. Default is /mnt/local/downloads/torrents.

    • Example: ruTorrent would download into /mnt/local/downloads/torrents/rutorrent/completed.

• plex:

  • tag: Determines what version of Plex to install. Options are public, beta, or version tag (e.g. "1.12.3.4973-215c28d86"). Default is public.

    • Note 1: The public tag restricts this check to public versions only, where as, beta tag will fetch beta versions. If the server is not logged in or you do not have an active Plex Pass on your Plex account, the beta tag will only install the publicly available versions only.

    • Note 2: Hardware Transcoding requires an active Plex Pass. This can be enabled on either the public or beta tagged versions.

    • 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.

• rclone:

  • version: Rclone version that is installed by Cloudbox. Choices are latest (or current), beta, or a specific version number (e.g. 1.42). Default is latest.

• 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/).

  • 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/).

  • rclone_dest: Path for cloud backups (e.g. Google Drive). Older backups are stored in the archived folder. Default is google:/Backups.

    • Note: Ensure the path does NOT have a trailing slash (/) or else backup "could" fail (i.e. /sample/path, but not /sample/path/).

  • keep_local_copy: Option to save local copies of the backup file in tar_dest after backup is complete. Default is true.

  • use_rsync: Option to enable/disable rsync backups. Options are true or false. Default is false.

  • use_rclone: Option to enable/disable cloud (i.e Google Drive) backups. Options are true or false. Default is false.

  • cron_time: How often to backup should run (only when cron_state is set to present). Options are reboot, yearly, annually, weekly, daily, or hourly. Default is weekly.

    • 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 are absent or present. Default is absent.

    • absent will remove any existing backup schedule.

    • present will ensure it is always scheduled.

    • Note 1: Whenever this option is changed (e.g. absent to present; present to absent), 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 the pushover_app_token and the pushover_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 the pushover_app_token and the pushover_user_key). Default is blank.

---

The following settings are deprecated, new users will leave them blank (but not completely remove them):

• nzbget

  • downloads: Path for NZBGet downloads.

• rutorrent:

  • downloads: Path for ruTorrent downloads.