Folder Setup

SABnzbd uses a number of folders for different purposes. Some are just for internal administration.
Given that some folders can become very large, you may want to relocate them.

The following table explains the purpose of each folder, its default location and its keyword in the INI file. All folders can be changed through the Web-GUI also.
The expression %userprofile% is for Windows: your personal folder under "c:\Documents and Settings" (for Vista, these names are different).
For Posix1 and OSX, ~ means your home folder.

NOTE for experienced users:
The paths of the log_dir, nzb_backup_dir and cache_dir will be relative to the location of the INI file unless a fixed path is set.
The download_dir (incomplete) complete_dir and dirscan_dir are relative from the current users home directlry (My Documents in windows).

You CAN set fixed paths such as D:\Downloads, or /Volumes/nameofdrive/Downloads - however the path must be accessible to SABnzbd when it is launched otherwise it will be reset to the default path,

sabnzbd.ini
XP/2003 %userprofile%\local settings\application data\sabnzbd\sabnzbd.ini
Vista + %userprofile%\AppData\Local\sabnzbd\sabnzbd.ini
Posix ~/.sabnzbd/sabnzbd.ini
OSX ~/.sabnzbd/sabnzbd.ini
download_dir
Windows %userprofile%\My Documents\downloads\incomplete
Posix ~/.sabnzbd/downloads/incomplete
OSX ~/.sabnzbd/downloads/incomplete
Here SABnzbd collects the data for each download and error correction (par2) is done. When complete, the data is moved to the "complete_dir". There should be enough space to contain the largest complete job + 10% for error correction data.
complete_dir
Windows %userprofile%\My Documents\downloads\complete
Posix ~/downloads/complete
OSX ~/downloads/complete
Here all completed download jobs are stored. Each job is placed in a separate folder, named after the NZB file that started it. You want to put this on a volume with plenty of room.
dirscan_dir
Windows %userprofile%\My Documents\nzb
Posix ~/nzb
OSX ~/nzb
Any NZB file you store in this folder will be picked up by SABnzbd and will start a download job. When the job is in the queue, the NZB file will be removed.
log_dir
XP/2003 %userprofile%\local settings\application data\sabnzbd\log_dir
Vista + %userprofile%\AppData\Local\sabnzbd\log_dir
Posix ~/.sabnzbd/log_dir
OSX ~/.sabnzbd/log_dir
Here SABnzbd's logging is stored. Altough only needed for troubleshooting, you must have this folder. Growth of this folder is normally limited to 5 MB.
nzb_backup_dir
XP/2003 %userprofile%\local settings\application data\sabnzbd\nzb
Vista + %userprofile%\AppData\Local\sabnzbd\nzb
Posix ~/.sabnzbd/nzb
OSX ~/.sabnzbd/nzb
Here all processed NZB files are stored. You may need them again, should a download fail. This folder will keep growing. If you don't specify a folder, the NZB files will not be saved.
admin_dir
XP/2003 %userprofile%\local settings\application data\sabnzbd\admin
Vista + %userprofile%\AppData\Local\sabnzbd\admin
Posix ~/.sabnzbd/admin
OSX ~/.sabnzbd/admin
Used for the internal administration of the job-queue and history
cache_dir 0.4.x and 0.5.x only
XP/2003 %userprofile%\local settings\application data\sabnzbd\cache
Vista + %userprofile%\AppData\Local\sabnzbd\cache
Posix ~/.sabnzbd/cache
OSX ~/.sabnzbd/cache
Used for the internal administration of the job-queue and history and article cache. Can grow large.
web_dir
Windows <SABnzbd-program-dir>\interfaces\Default
Posix <SABnzbd-program-dir>/interfaces/Default
OSX <SABnzbd-program-dir>/interfaces/Default
Location of the HTML templates of SABnzbd, defining the look of SABnzbd's web interface. You may add alternative interfaces here as long as they follow the structure of Default. So the main page of a new interface would actually be <SABnzbd-program-dir>/interfaces/MyThing/templates/main.tmpl
Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License