Skip to content
This repository was archived by the owner on Mar 7, 2025. It is now read-only.

cb utility script

Chaz Larson edited this page Jan 20, 2021 · 5 revisions

The Develop branch installs a helper script as cb.

This script is intended to provide shortcuts for common tasks.

Currently it can be used to run cloudbox roles and update the cloudbox repo.

Usage:
    cb [-h]                Display this help message.
    cb install <package>   Install <package>.
    cb update              Update Cloudbox project folder.

Using this script, you can run:

cb install SOMETAG

instead of:

cd ~/cloudbox && sudo ansible-playbook cloudbox.yml --tags SOMETAG

Also:

cb update

instead of:

cd ~/cloudbox && git fetch && git reset --hard @{u}

You can run this helper from anywhere; you don't have to cd into the cloudbox directory first.

"ArrX" functionality

For some tags, the script can install an instance of a container with an arbitrary name:

cb install plex -e plex_name=plex_bing

would install a plex_bing container that stores its data in /opt/plex_bing and is accessible at https://plex_bing.DOMAIN.TLD.

Current roles that support this feature are:

cloudplow
emby
jackett
lidarr
mariadb
netdata
nzbget
nzbhydra2
ombi
plex
portainer
radarr
rutorrent
sabnzbd
sonarr
sstvirl
tautulli
trackarr

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 (Choose only one of these)
  3. Settings
  4. Preinstall (Choose only one of these)
  5. SSH
  6. Ansible Vault
  7. Rclone
  8. Cloudbox (Choose only one of these)
  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
  10. Next Steps

Install Feederbox / Mediabox

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

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

Recommended Reading

Backup and Restore

More Information

Advanced Configuration

Experimental

Extras

Misc

Community-Submitted

See Community Wiki.

Reference

Troubleshooting

Links

Clone this wiki locally