RustyGet docs · rewrite in progress
Source

rustyget::docs::quick_start

Get started

Quick start

Five settings get RustyGet downloading. Three more turn on the duplicate fleet features that set it apart.

Open the web interface at http://<host>:6789 and go to Settings. Finish your edits, click Save all changes, then reload when prompted. The illustrated Settings guides cover every section.

Set up the basics

  1. Secure the interface. In SECURITY, set ControlUsername and ControlPassword. Give other programs their own accounts: RestrictedUsername can do everything except change settings, which suits media managers, and AddUsername can only add downloads.

  2. Add your news servers. In NEWS-SERVERS, enter the host, port, user name, password, and connection count from your provider. Keep encryption on. Click Test connection. Add block accounts as fill servers at level 1. See News servers.

  3. Choose your folders. In PATHS, set MainDir. The other paths default to folders inside it: DestDir for finished files, InterDir for downloads in progress, NzbDir for incoming NZB files, and QueueDir for the queue and history.

  4. Add categories. In CATEGORIES, add one per kind of download, such as Movies and TV, each with its own DestDir. Media managers and the Kodi add-on send a category with each download.

  5. Check unpacking. In UNPACK, make sure UnrarCmd and SevenZipCmd point to working programs.

Add a download

You can add NZB files in several ways:

  • Web interface: click Add and choose a file or paste a URL.
  • Watched folder: drop the file into NzbDir. A subfolder's name becomes the download's category.
  • Media managers: in Sonarr, Radarr, or Lidarr, add a download client of type NZBGet with your host, port, and the RestrictedUsername account. Media managers also read the queue, history, and settings and edit the queue, which an AddUsername account can't do.
  • Kodi: the NeNeTeePee Stream add-on sends a whole fleet of copies at once. See Streaming with Kodi.
  • API: call append or appendfleet. See API and compatibility.

Watch the download in the Downloads tab. When it finishes, the History tab shows the result, the health, and each post-processing step.

Turn on duplicate fleets

These settings live in INCOMING NZBS, DOWNLOAD QUEUE, and CHECK AND REPAIR. Each defaults to NZBGet's behavior, so turn them on in this order and watch a few downloads after each step.

Step Setting Section Effect
1 DupeCheck=yes INCOMING NZBS Groups copies of the same title by duplicate key and keeps backups in history. On by default.
2 HealthCheck=dupe CHECK AND REPAIR Fails over early to a better copy when a download can't complete.
3 DupeArticleFallback=article INCOMING NZBS Fetches articles that no server has from duplicate postings. Use live to also repair bytes while downloading.
4 NzbCleanupDisk=no DOWNLOAD QUEUE Keeps the NZB files of history items, so they can still serve as sources.
5 DupeSearch=yes INCOMING NZBS Searches NZBHydra2 for more copies of each new download. Start with DupeSearchDryRun=yes.

Duplicate fleets explains each step, and Configuration options lists every setting.