otty / dotfiles

All tools/SABnzbd

SABnzbd

sabnzbd

The free and easy binary newsreader.

Detected by sabnzbd | macOS, Linux, Windows |sabnzbd.org

Sync it sabnzbd.toml

Sync rules

What travels, what stays, what never leaves

SABnzbd in your home directory Every rule on this page, by file

…

api_key = FAKE0000111122223333444455556666

nzb_key = FAKE7777888899990000aaaabbbbcccc

web_dir = Glitter

download_dir = /Volumes/media/incompletemachine-local

complete_dir = /Volumes/media/completemachine-local

dirscan_dir = /Users/octocat/Downloads/watchmachine-local

script_dir = /Users/octocat/.sabnzbd/scriptsmachine-local

nzb_backup_dir = /Volumes/media/nzb-backupmachine-local

admin_dir = admin

log_dir = logs

email_server = smtp.example.com:587

…

Each machine keeps its own copy of these.

api_keynzb_keypasswordemail_pwd

Lifted into your secret store; the rest of the file syncs.

download_dircomplete_dirdirscan_dirscript_dirnzb_backup_dir

Each machine keeps its own copy of these.

api_keynzb_keypasswordemail_pwd

Lifted into your secret store; the rest of the file syncs.

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/sabnzbd.tomlThe file this page is generated from

id = "sabnzbd"

name = "SABnzbd"

homepage = "https://sabnzbd.org"

description = "The free and easy binary newsreader."

# The app icon at the largest size sabnzbd.org publishes.

icon = "https://sabnzbd.org/images/icons/android-192x192.png"

detect = ["sabnzbd"]

# SABnzbd.py, get_user_profile_paths(), picks the data directory per platform

# and SABnzbd.py then opens DEF_INI_FILE inside it

# (`inifile = os.path.abspath(os.path.join(sabnzbd.DIR_LCLDATA, DEF_INI_FILE))`).

# sabnzbd/constants.py sets DEF_INI_FILE = "sabnzbd.ini" and DEF_WORKDIR =

# "sabnzbd", and the three branches are:

# Windows CSIDL_LOCAL_APPDATA joined with DEF_WORKDIR, i.e.

# %LOCALAPPDATA%\sabnzbd (the except branch spells it out by

# rewriting AppData\Roaming to AppData\Local)

# macOS "%s/Library/Application Support/SABnzbd" % home

# Unix "%s/.%s" % (home, DEF_WORKDIR), i.e. ~/.sabnzbd

# [dataHome] is ~/Library/Application Support on macOS and %LOCALAPPDATA% on

# Windows, so it covers those two exactly; the name differs only in case between

# them and both filesystems are case-insensitive. Linux lands somewhere else

# entirely and is written out. On Linux [dataHome] resolves to

# ~/.local/share/SABnzbd, which SABnzbd never creates, and a consumer skips a

# path that is not on disk.

paths = [

"~/.sabnzbd/sabnzbd.ini",

"[dataHome]/SABnzbd/sabnzbd.ini",

]

# The admin database, logs and .nzb backups live in directories named *by*

# sabnzbd.ini rather than inside it, so there is nothing to carve out of the

# file itself.

exclude = []

# Not a whole-file secret: the newsreader is configured almost entirely in this

# file — categories, sorting, scheduling, post-processing — and only the

# credential lines are lifted out below.

secret = []

# sabnzbd/cfg.py declares each of these in the "misc" section:

# api_key and nzb_key are generated by create_api_key() and are the tokens that

# authenticate every API call; password and email_pwd are OptionPassword, the

# web-interface login and the SMTP password. A `password` line also appears

# under each [servers] section, which is the Usenet account password, and the

# same prefix reaches it.

[[secret_paths]]

file = ["~/.sabnzbd/sabnzbd.ini", "[dataHome]/SABnzbd/sabnzbd.ini"]

match = { prefix = ["api_key", "nzb_key", "password", "email_pwd"] }

# Directories on this disk, each declared in sabnzbd/cfg.py as an OptionDir:

# download_dir and complete_dir are where downloads land and end up, dirscan_dir

# is the watched folder, script_dir holds the post-processing scripts and

# nzb_backup_dir the kept .nzb files. All five are normally absolute and mean

# nothing on another machine.

# host, port and https_port are deliberately absent even though the web

# interface's bind address is machine-local: a prefix matches a line, not a

# section, and the same three keys appear again under each [servers] block,

# where they are the Usenet provider's address and are exactly what a user wants

# carried over.

[[machine_lines]]

file = ["~/.sabnzbd/sabnzbd.ini", "[dataHome]/SABnzbd/sabnzbd.ini"]

scope = "backup"

match = { prefix = [

"download_dir",

"complete_dir",

"dirscan_dir",

"script_dir",

"nzb_backup_dir",

] }

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/sabnzbd. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these is generated from the same rules as this page. None of them splits download_dir and complete_dir for you — that part is Otty’s own sync, or a template you write by hand.