DEPRECATED Configure Settings Test - dibrz/ARMBand GitHub Wiki
cd ~/cloudbox
nano settings.yml
| Parameter |
Sub-Parameter |
Definition |
Required |
Choices |
Default |
Notes |
|---|---|---|---|---|---|---|
user |
User account for Cloudbox. | no | seed |
It will be created if it doesn't already exist. | ||
passwd |
Password for user account. | no | Only needed if user account is being created Note: Password must be in alphanumeric characters. No special characters. |
|||
domain |
Your domain name. | yes | If you don't have one, see [[Prerequisites | |||
email |
Your e-mail address. | yes | This is used to get SSL certificates. | |||
nzbget |
||||||
downloads |
Path for NZBGet downloads. | yes | "/home/{{user}}/downloads/nzbget" |
|||
rutorrent |
||||||
passwd |
Password to be used for ruTorrent webgui | yes | Note: Password must be in alpha or alphanumeric characters (but not only numeric ones). No special characters. | |||
downloads |
Path for ruTorrent downloads | yes | "/home/{{user}}/downloads/rutorrent" |
|||
plex |
||||||
tag |
Determines what recent version to install. | yes |
publicplexpass
|
public |
Use plexpass only if you have an active Plex Pass. This can be changed later by running the installer again. |
|
transcodes |
Path of temporary transcoding files. | yes | "/home/{{user}}/transcodes" |
Note: DO NOT use /tmp or /dev/shm as a transcode location. On reboots, /tmp and /dev/shm are cleared and this causes docker to recreate the folder as root, causing the plex transcoder to crash. See this comment from a Plex employee: https://forums.plex.tv/discussion/comment/1502936/#Comment_1502936. | ||
plex_autoscan |
||||||
ip |
Server IP that Plex_Autoscan will listen on. | yes | 0.0.0.0 |
|||
rclone |
||||||
version |
Rclone version that is installed with Cloudbox | yes | 1.36 |
Default version is the most stable tested version | ||
unionfs_cleaner |
||||||
max_local_gigabytes |
Max size in GB allowed for local media before is moved to the cloud. | yes | 200 |
|||
size_check_mins |
How often in minutes local media size is checked. | yes | 30 |
|||
rclone_remote |
Should not be changed. | yes | "google:" |
|||
backup |
||||||
tgz_dest |
Path for local backups (.tar). | no | "/home/{{user}}/Backups" |
Only the two most recent copies are kept. Note: Ensure the path does NOT have a trailing slash (/) or else backup will fail (i.e. /sample/path, not /sample/path/). |
||
rsync_dest |
Path for rsync backups (.tar). | no | Only the two most recent copies are kept. Note: Ensure the path does NOT have a trailing slash (/) or else backup will fail (i.e. /sample/path, not /sample/path/). |
|||
rclone_dest |
Path for cloud (i.e. Google Drive) backups. | no | google:/Backups |
Only the two most recent copies are kept. | ||
use_rsync |
Option to enable/disable rsync backup. | yes |
true false
|
false |
If set to true, you must specify rsync_dest. |
|
use_rclone |
Option to enable/disable cloud (i.e. Google Drive) backups. | yes |
true false
|
false |
If set to true, you must specify rclone_dest. |
|
cron_time |
How often to backup. | no |
rebootyearlyannuallyweeklydailyhourly
|
weekly |
Only needed when cron_state is set to present Note 1: 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). Note 2: This option just allows the script to schedule the backup for you. You can manually schedule cron to run backups with ansible-playbook cloudbox.yml --tags backup called as root. |
|
cron_state |
Option to enable/disable automatic backups. | yes |
absent present
|
absent |
If set to present, you must specify cron_time. absent will remove any existing backup schedule. present will ensure it is always scheduled. Note: When this option changed (whether to present or absent), a manual backup must be run once in order to set the backup schedule (i.e. sudo ansible-playbook cloudbox.yml --tags backup). In case the absent option is set, it will disable further backups after running the manual backup; however, you can manually remove the cron job (i.e. sudo crontab -e) if you did not want to run a manual backup command to do so. |
-
CTRL-X, theny, thenenterkey.