Copyright © 2007-2008 - Andrei Prygounkov - all rights reserved
About NZBGet
History
Download
Prerequisites on POSIX
Installation on POSIX
Compiling on Windows
Configuration
Usage
XML-RPC and JSON-RPC
Web-interface
Authors
Copyright
Contact
NZBGet is a binary newsgrabber, which downloads files from usenet based on information given in nzb-files. NZBGet can be used in standalone and in server/client modes. In standalone mode you pass a nzb-file as parameter in command-line, NZBGet downloads listed files and then exits.
In server/client mode NZBGet runs as server in background. Then you use client to send requests to server. The sample requests are: download nzb-file, list files in queue, etc.
Standalone-tool, server and client are all contained in only one executable file "nzbget". The mode in which the program works depends on command-line parameters passed to the program.
NZBGet is written in C++ and was initialy developed on Linux. It was ported to Windows later and tested for compatibility with several POSIX-OS'es.
The current version (0.4.0) should run at least on:
The previous version (0.3.0) was also tested on:
Clients and servers running on different OS'es may communicate with each other. For example, you can use NZBGet as client on Windows to control your NZBGet-server running on Linux.
The download-section of NZBGet web-site provides binary files for Windows. The binary packages for many routers and NAS devices are also available in OPTWARE repository (http://www.nslu2-linux.org), but for most POSIX-systems you need to compile the program yourself.
If you have downloaded binaries you can just jump to section "Configuration".
Official releases can be downloaded from download section at SourceForge.
The latest development sources are available in subversion repository.
NZBGet is developed on a linux-system, but it should run on other POSIX platforms (see the list of tested platforms above).
NZBGet absolutely needs the following libraries:
And the following libraries are optional:
For curses-output-mode:
or (better)
For par-check and -repair:
All these libraries are included in modern Linux distributions and should be available as installable packages. Please note that you also need the developer packages for these libraries too, they package names have often suffix "dev" or "devel". On other systems you may need to download the libraries at the given URLs and compile them (see hints below).
Well, the usual stuff:
tar -zxf nzbget-VERSION.tar.gz
cd nzbget-VERSION
./configure
./configure --help is your friend! ;-)
also see "Configure-options later.)
make
su
make install
You may run configure with additional arguments:
--disable-curses--disable-parcheck--enable-debugNZBGet can check and repair downloaded files for you. For this purpose it uses library par2 (libpar2), which needs sigc++ on its part.
Parcheck-Package is enabled by default. To build without par-check use option "--disable-parcheck" while running
configure:
./configure --disable-parcheck
The libpar2 and libsigc++ (version 2 or later) must be installed on your
system. On most linux distributions these libraries are available as packages.
So you only need to install theme and run configure with parameter
--enable-parcheck.
If you do not have these package you can compile them yourself.
Following configure-parameters may be usefull:
--with-libpar2-includes
--with-libpar2-libraries
--with-libsigc-includes
--with-libsigc-libraries
The library libsigc++ must be installed first, since libpar2 requires it.
For curses-outputmode you need ncurses or curses on your system.
If you do not have one of them you can download and compile ncurses yourself.
Following configure-parameters may be usefull:
--with-libcurses-includes
--with-libcurses-libraries
If you are not able to use curses or ncurses or do not want them you can
make the program without support for curses using option --disable-curses:
./configure --disable-curses
NZBGet is developed using MS Visual C++ 2005. The project file and solution are provided. If you use MS Visual C++ 2005 Express you need to download and install Platform SDK.
To compile the program with par-check-support you also need the following libraries:
Download these libaries, then use patch-files provided with NZBGet to create preconfigured project files and solutions for each library. Look at Patch for Windows home page for info on how to use patch-files, if you do not familiar with this technique.
After libsigc++ and libpar2 are compiled in static libraries (.lib) and include- and libraries-paths are configured in MS Visual C++ 2005 you should be able to compile NZBGet.
NZBGet needs a configuration-file to work properly.
You need to set at least the option "MAINDIR" and one newsserver in configuration file. Have a look at the example in nzbget.conf.example, it has comments on how to use each option.
The program looks for configuration file in following standard locations (in this order):
On POSIX systems:
~/.nzbget
/etc/nzbget.conf
/usr/etc/nzbget.conf
/usr/local/etc/nzbget.conf
/opt/etc/nzbget.conf
On Windows:
<EXE-DIR>\nzbget.conf
If you put the configuration file in other place, you can use command-
line switch "-c <filename>" to point the program to correct location.
In special cases you can run program without configuration file using
switch "-n". You need to use switch "-o" to pass required configuration
options via command-line.
NZBGet can be used in either standalone mode which downloads a single file or as a server which is able to queue up numerous download requests.
nzbget <nzb-file>
First start the nzbget-server:
A) in console mode:
nzbget -s
B) or in daemon mode (POSIX only):
nzbget -D
C) or as a service (Windowx only, firstly install the service with command
"nzbget -install"):
net start NZBGet
To stop server use:
nzbget -Q
Depending on which frontend has been selected in the nzbget.conf file (option "outputmode") the server should display a message that it is ready to receive download requests (this applies only to console mode, not to daemon mode).
When the server is running it is possible to queue up downloads. This can be
done either in terminal with
nzbget -A <nzb-file>
or by uploading a nzb-file into server's monitor-directory (<MAINDIR>/nzb by default).
To check the status of server start client and connect it to server:
nzbget -C
The client have three different (display) outputmodes, which you can select
in configuration file (on client computer) or in command line. Try them:
nzbget -o outputmode=log -C
nzbget -o outputmode=color -C
nzbget -o outputmode=curses -C
To list files in server's queue:
nzbget -L
It prints something like:
[1] nzbname\filename1.rar (50.00 MB)
[2] nzbname\filename1.r01 (50.00 MB)
The numbers in square braces are ID's of files in queue. They can be used
in edit-command. For example to move file with ID 2 to the top of queue:
nzbget -E T 2
or to pause files with IDs from 10 to 20:
nzbget -E P 10-20
or to delete file from queue:
nzbget -E D 3 10-15 20-21 16
The edit-command has also a group-mode which affects all files from the
same nzb-request. You need to pass one ID of any file in the group. For
example to delete all files from the first nzb-request:
nzbget -E G D 1
The switch "o" is useful to override options in configuration files.
For example:
nzbget -o reloadqueue=no -o dupecheck=no -o parcheck=yes -s
or:
nzbget -o createlog=no -C
Since nzbget communicates via TCP/IP it's possible to have a server running on one computer and adding downloads via a client on another computer.
Do this by setting the "serverip" option in the nzbget.conf file to point to the IP of the server (default is localhost which means client and server runs on same computer)
NZBGet communicates via unsecured socket connections. This makes it vulnerable. Although server checks the password passed by client, this password is still transmitted in unsecured way. For this reason it is highly recommended to configure your Firewall to not expose the port used by NZBGet to WAN.
If you need to control server from WAN it is better to connect to server's terminal via SSH (POSIX) or remote desktop (Windows) and then run nzbget-client-commands in this terminal.
From the version 0.4.0 NZBGet has supported XML-RPC and JSON-RPC.
The description of XML-RPC and JSON-RPC commands is available in this document.
NZBGetWeb is a PHP-application, which allows you to control NZBGet-server from a web-browser. It is available from Download section as package "web-interface". NZBGetWeb uses JSON-RPC or XML-RPC (depending of what PHP-libraries insalled on your system) to communicate with NZBGet-server.
NZBGetWeb requires NZBGet version 0.4.0 or later.
NZBGet was initialiy written by Sven Henkel (sidddy@users.sourceforge.net).
Up to version 0.2.3 it was been developed and maintained by Bo Cordes Petersen (placebodk@users.sourceforge.net).
Beginning at version 0.3.0 the program is being developed by Andrei Prygounkov (hugbug@users.sourceforge.net).
Package "web-interface" is based on open-source-project ZussaWeb. The adaptation for NZBGet-server and father development was made by Andrei Prygounkov (hugbug@users.sourceforge.net).
NZBGet is distributed under GNU General Pubic License Version 2. The complete content of license is provided in file COPYING.
Binary distribution of NZBGet for Windows contains code from the following libraries:
libpar2 is distributed under GPL and libsigc++ under LGPL.
If you encounter any problem, feel free to use tracker/forums on http://sourceforge.net/projects/nzbget or contact me at hugbug@users.sourceforge.net
|
Last updated: 8 Apr. 2008 Copyright © 2007-2008 - Andrei Prygounkov - all rights reserved |
|