Skip to content

Options in accounts.yml

desimaniac edited this page Jun 1, 2019 · 21 revisions
  • user: User information.

    • name: User name for the server.

      • If user account with this name does not already exist, it will be created during install.

      • Also used to create first-time logins for NZBGet, ruTorrent, NZBHydra2, and potentially other apps.

      • Default is seed.

      • This parameter is required.

    • pass: Password for the user account and for misc apps.

      • Sets password for the server's user account when creating a new account. This will not change the password of an existing one.

      • Also used to create first-time logins for NZBGet, ruTorrent, NZBHydra2, and potentially other apps.

      • This parameter is required.

    • domain: Domain name for the Cloudbox server.

      • If you don't have one, see here.

      • This parameter is required.

    • email: E-mail address.

      • This is used for the Let's Encrypt SSL certificates.

      • This parameter is required.

  • cloudflare: Cloudflare Account

    • Fill this in to have Cloudbox add subdomains on Cloudflare, automatically; leave it blank, to have all Cloudflare related functions disabled.

    • Note: CDN (i.e. proxy) will not be turned on, by default, but you may turn them on later (see here).

    • email: E-mail address used for the Cloudflare account.

    • api: API Token.

    • This parameter is optional.

    • Default is blank.

  • plex: Plex.tv account credentials.

    • This will be used to 1) claim the Plex server under your username, and 2) generate Plex Access Tokens for apps such as Plex Autoscan, etc.

    • user - Plex username or email address on the profile.

    • pass - Plex password.

    • This parameter is optional.

  • pushover: Pushover settings.

    • This will be used to send out messages during certain tasks (e.g. backup).

    • app_token - Pushover Application API Token (create a new application for Cloudbox).

    • user_key - Pushover User Key.

    • priority - Priority level for messages.

      • Choices are: -2, -1, 0, 1, and 2.

      • Default is blank (i.e. 0).

    • This parameter is optional.

Home

Basics

  1. Introduction
  2. Cloudbox Install Types
  3. Cloudbox Paths
  4. Accessing Cloudbox Apps

Prerequisites

  1. Overview
  2. Presumptions
  3. Server
  4. Domain Name
  5. Cloudflare
  6. Cloud Storage
  7. Plex / Emby - Account
  8. Usenet vs. BitTorrent

Install Cloudbox

Cloudbox
  1. Overview
  2. Dependencies
  3. Ansible Vault
  4. Settings
  5. Preinstall
  6. SSH
  7. Rclone
  8. Cloudbox
  9. Application Setup
    1. NZBGet
    2. ruTorrent
    3. NZBHydra2
    4. Jackett
    5. Plex Media Server
    6. Plex Autoscan
    7. Sonarr
    8. Radarr
    9. Lidarr
    10. PlexPy (Tautulli)
    11. Ombi
    12. Portainer
    13. Organizr

Install Mediabox / Feederbox

Feederbox (do this first)
  1. Overview
  2. Dependencies
  3. Ansible Vault
  4. Settings
  5. Preinstall
  6. SSH
  7. Rclone
  8. Feederbox
  9. Application Setup
    1. NZBGet
    2. ruTorrent
    3. NZBHydra2
    4. Jackett
    5. Sonarr
    6. Radarr
    7. Lidarr
    8. Portainer
    9. Organizr

Mediabox
  1. Overview
  2. Dependencies
  3. Ansible Vault
  4. Settings
  5. Preinstall
  6. SSH
  7. Rclone
  8. Mediabox
  9. Application Setup
    1. Feeder Mount
    2. Plex Media Server
    3. Plex Autoscan
    4. PlexPy (Tautulli)
    5. Ombi

Recommended Reading

Backup and Restore

More Information

Advanced Configuration

Experimental

Extras

Docs coming soon for ...

  • Radarr4K
  • Sonarr4K

Misc Guides

Reference

Troubleshooting

Links

Community Project

Clone this wiki locally
You can’t perform that action at this time.