├── README.md ├── Untitled Document.md.html ├── add_plex_to_cloudflare.md ├── enable_igpu_on_hetzner.md └── my_sonarr_and_radarr_naming_guide.md /README.md: -------------------------------------------------------------------------------- 1 | # docs 2 | 3 | Just some random guides and docs. 4 | -------------------------------------------------------------------------------- /Untitled Document.md.html: -------------------------------------------------------------------------------- 1 |
Parameter | 6 |Sub-Parameter | 7 |Definition | 8 |Required | 9 |Choices | 10 |Default | 11 |Notes | 12 |
---|---|---|---|---|---|---|
user |
17 | 18 | | User account for Cloudbox | 19 |no | 20 |21 | | seed |
22 | It will be created if it doesn’t already exist. <br /> Specify passwd below if one needs to be created. | 23 |
passwd |
26 | 27 | | Password for user account | 28 |no | 29 |30 | | 31 | | Only needed if user account is being created <br /> <br /> Note: Password must be in alphanumeric characters. No special characters. | 32 |
domain |
35 | 36 | | Your domain name. | 37 |yes | 38 |39 | | 40 | | If you don’t have one, see [[Prerequisites | 41 |
email |
44 | 45 | | Your e-mail address. | 46 |yes | 47 |48 | | 49 | | This is used to get SSL certificates. | 50 |
nzbget |
53 | 54 | | 55 | | 56 | | 57 | | 58 | | 59 | |
62 | | downloads |
63 | Path for NZBGet downloads. | 64 |yes | 65 |66 | | "/home/{{user}}/downloads/nzbget" |
67 | 68 | |
rutorrent |
71 | 72 | | 73 | | 74 | | 75 | | 76 | | 77 | |
80 | | passwd |
81 | Password to be used for ruTorrent webgui | 82 |yes | 83 |84 | | 85 | | Note: Password must be in alpha or alphanumeric characters (but not only numeric ones). No special characters. | 86 |
89 | | downloads |
90 | Path for ruTorrent downloads | 91 |yes | 92 |93 | | "/home/{{user}}/downloads/rutorrent" |
94 | 95 | |
plex |
98 | 99 | | 100 | | 101 | | 102 | | 103 | | 104 | |
107 | | tag |
108 | Determines what recent version to install. | 109 |yes | 110 |public <br /> plexpass |
111 | public |
112 | Use plexpass only if you have an active Plex Pass. This can be changed later by running the installer again. |
113 |
116 | | transcodes |
117 | Path of temporary transcoding files. | 118 |yes | 119 |120 | | "/home/{{user}}/transcodes" |
121 | 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. | 122 |
plex_autoscan |
125 | 126 | | 127 | | 128 | | 129 | | 130 | | 131 | |
134 | | ip |
135 | Server IP that Plex_Autoscan will listen on. | 136 |yes | 137 |138 | | 0.0.0.0 |
139 | 140 | |
rclone |
143 | 144 | | 145 | | 146 | | 147 | | 148 | | 149 | |
152 | | version |
153 | Rclone version that is installed with Cloudbox | 154 |yes | 155 |156 | | 1.36 |
157 | Default version is the most stable tested version | 158 |
unionfs_cleaner |
161 | 162 | | 163 | | 164 | | 165 | | 166 | | 167 | |
170 | | max_local_gigabytes |
171 | Max size in GB allowed for local media before is moved to the cloud. | 172 |yes | 173 |174 | | 200 |
175 | 176 | |
179 | | size_check_mins |
180 | How often in minutes local media size is checked. | 181 |yes | 182 |183 | | 30 |
184 | 185 | |
188 | | rclone_remote |
189 | Should not be changed. | 190 |yes | 191 |192 | | "google:" |
193 | 194 | |
backup |
197 | 198 | | 199 | | 200 | | 201 | | 202 | | 203 | |
206 | | tgz_dest |
207 | Path for local backups (.tar). | 208 |no | 209 |210 | | "/home/{{user}}/Backups" |
211 | Only the two most recent copies are kept. <br /> <br /> Note: Ensure the path does NOT have a trailing slash (/) or else backup will fail (i.e. /sample/path , not /sample/path/ ). |
212 |
215 | | rsync_dest |
216 | Path for rsync backups (.tar). | 217 |no | 218 |219 | | 220 | | Only the two most recent copies are kept. <br /> <br /> Note: Ensure the path does NOT have a trailing slash (/) or else backup will fail (i.e. /sample/path , not /sample/path/ ). |
221 |
224 | | rclone_dest |
225 | Path for cloud (i.e. Google Drive) backups. | 226 |no | 227 |228 | | google:/Backups |
229 | Only the two most recent copies are kept. | 230 |
233 | | use_rsync |
234 | Option to enable/disable rsync backup. | 235 |yes | 236 |true <br /> false |
237 | false |
238 | If set to true , you must specify rsync_dest . |
239 |
242 | | use_rclone |
243 | Option to enable/disable cloud (i.e. Google Drive) backups. | 244 |yes | 245 |true <br /> false |
246 | false |
247 | If set to true , you must specify rclone_dest . |
248 |
251 | | cron_time |
252 | How often to backup. | 253 |no | 254 |reboot <br /> yearly <br /> annually <br /> weekly <br /> daily <br /> hourly |
255 | weekly |
256 | Only needed when cron_state is set to present <br /> <br /> 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). <br /> 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. |
257 |
260 | | cron_state |
261 | Option to enable/disable automatic backups. | 262 |yes | 263 |absent <br /> present |
264 | absent |
265 | If set to present , you must specify cron_time . <br /> <br /> absent will remove any existing backup schedule. present will ensure it is always scheduled. <br /> <br /> 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. |
266 |