NZBGet - ArchWiki

Jump to content

# NZBGet

From ArchWiki

NZBGet is an Usenet-client written in C++ and designed with performance in mind to achieve maximum download speed by using very little system resources.

## Installation

Install the nzbget package.

## Configuring NZBGet

Note `nzbget.conf` configuration files are typically stored in your home directory or in `/etc/nzbget.conf` The program looks for configuration file in several standard locations. For details: HOW_TO_USE.md#configuration

`/var/lib/nzbget/nzbget.conf` is not one of the locations the program will search by default. However, the upstream source also provides the `nzbget.service` file which expects the configuration file at this location. For this reason, the following instructions will use `/var/lib/nzbget/nzbget.conf` See Systemd#Editing_provided_units for possible options to modify/replace the provided `nzbget.service`

Copy the template configuration file to a custom directory:

    # cp /usr/share/nzbget/nzbget.conf /var/lib/nzbget/nzbget.conf

Update the configuration before starting NZBGet:

    /var/lib/nzbget/nzbget.conf

    ..
    WebDir=/usr/share/nzbget/webui
    ScriptDir=/usr/share/nzbget/scripts
    LockFile=/var/lib/nzbget/nzbget.lock
    ConfigTemplate=/usr/share/nzbget/nzbget.conf
    DaemonUsername=nzbget
    ..

Make sure the permissions are set correctly:

    # chown -R nzbget:nzbget /var/lib/nzbget
    # chmod -R 750 /var/lib/nzbget

## Starting NZBGet

You can start/enable the `nzbget.service`, or start it manually:

- Running as root in console-mode:

      # nzbget -c /var/lib/nzbget/nzbget.conf -s

- Running as root in daemon-mode:

      # nzbget -c /var/lib/nzbget/nzbget.conf -D

NZBGet should now be accessible on http://localhost:6789.

## Running NZBGet under a different user

Note nzbget and nzbget-gitAUR provide the `nzbget` user and user group.

See system user for an example and reasons why it may be useful.

After adding a system user, update the main configuration file using the webinterface or by manually editing `/var/lib/nzbget/nzbget.conf`:

    /var/lib/nzbget/nzbget.conf

    ..
    DaemonUsername=nzbget # system user
    MainDir=/home/myuser/Downloads/NZBGet
    UMask=0002 # 775 for dirs - 664 for files

Create and set permissions for the desired directories:

    # mkdir /home/myuser/Downloads/NZBGet
    # chown -R nzbget:nzbget /home/myuser/Downloads/NZBGet
    # chmod 775 /home/myuser/Downloads/NZBGet

The `/home/myuser/Downloads/NZBGet` will be accessible for the user `nzbget` and for the `nzbget` group. Making the target directory world read/writable is highly discouraged (i.e. do not chmod the directory to 777). Instead, give individual users/groups appropriate permissions to the appropriate directories (e.g. by adding 'yourself' to the `nzbget` user group).

Starting NZBGet as user `nzbget` in daemon-mode:

    [nzbget]$ /usr/bin/nzbget -c /var/lib/nzbget/nzbget.conf -D

Or start the `nzbget.service` instead.

## Troubleshooting

### Default NZBGet credentials

The default credentials for NZBGet are `nzbget` as user and `tegbzn6789` as password. For security reasons it is recommended to change the default credentials.

### NZBGet crashes on start

This may happen when the user edited the NZBGet configuration by the Web-interface (located at http://localhost:6789), corrupting the configuration-file. Clean-up the configuration-file and restart the server/daemon again.

### Alternative systemd service

Start and enable `nzbget.service`.

### Unable to extract archives

Verify if unzip, unrar, 7zip and par2cmdline have been installed.

## See also

- NZBGet Documentation
- Performance Tips

Category:

- Usenet clients

NZBGet
Add topic