Skip to content
boranblok edited this page Aug 22, 2016 · 7 revisions

Configuration

To configure the application make a copy of the readme.txt in the userconf folder and name this 10-MyConfiguration.ini

This file comes preconfigured with most values set to a sensible default, but some settings will have to be changed in order to be able to use the application.

Once the settings here have been modified to your liking go to the Watchfolder Configuration page to set up watchfolders.

For more advanced info you can check out the Advanced Configuration page.

Settings

NewsHost Section

This section contains all info about the newshost provider where you want to post to. be aware not all newhost providers allow uploads, be sure this is possible before buying access.

Address

This is the address where you want to upload to, an example is reader.usenetbucket.com

Port

The port of your newshost you want to upload to usually 80 or 119 for non ssl and 443 or 563 for SSL

Username

Your username of the newshost provider

Password

Your password of the newshost provider

UseSSL

Wether or not to use SSL. Only enable this on actual SSL ports. Using SSL over port 80 or 119 will not work.

MaxConnectionCount

How many simultaneous connections to keep open to usenet. Do not set this too high because then the active connections will run out of things to upload and timeout causing a new connection to be opened on a subsequent request.

If you see warnings like this in your log lower this number:

WARN  nntpPoster.PostingThread - Posting thread is starved, reduce threads to make more optimal use of resources.
DEBUG nntpPoster.PostingThread - Disposing client because of empty queue.

Indexer Section

This section contains all the information required to notify the indexer of a new upload and verify wether or not an upload succeeded.

ApiKey

A shortcut that allows you to specify your api key in one place, use ${ApiKey} elsewhere in your configuration settings and it will be replaced by the value you configure here.

ObfuscatedNotificationUrl

API url that is used to notify the indexer of an obfuscated release.

The following tokens will be replaced by specific values:

{0} by the obfuscated name of the file/folder
{1} by the original name of the file/folder
${ApiKey} by the value specified in the ApiKey setting (see above)

SearchUrl

API url that is used to search the indexer.

The following tokens will be replaced by specific values:

{0} by the search query (the original name of the file/folder)
{1} by the age + 1 of the post in days (to limit to recent results only)
${ApiKey} by the value specified in the ApiKey setting (see above)

Folders Section

This section defines all the different folders that the application will use.

it is not required to change anything here as the defaults are sensible But if you want to keep all data on a separate drive or partition you might want to change some folders here.

All folders are written in the native OS format (C:\folder on windows, /folder on linux) Relative paths can be used by not starting with a /

NzbOutput

This is default left blank. If you want to output all .nzb files of your uploads to a folder fill in this setting. Be aware there is no clean-up mechanism of this folder so after a while there will be a lot of files here if you do not clean it yourself.

Backup

Files that are in the queue will be placed here and kept until they are verified on the index or the upload failed 3 times.

PostFailed

Files that failed to upload 3 times are placed here. It is recommended to check this folder from time to time to clean up.

Posting Section

This section defines behavior when posting files to usenet.

MaxRepostCount

How many attempts to take to post a file to usenet. If does not get found on the indexer after this many attempts the file or folder will be moved to the PostFailed folder.

RarNParSettings

This rather complicated setting defines the rules for creating rars and par2 information.

It consists of a repeatin (optional) section that defines from what filesize a certain rule is applied.

Some examples:

0,15,10

This will use a 15 MB rar size and 10 % par2 info for files from 0 MB onwards (all files)

0,15,10|1024,50,10|5120,100,5

This will use 15 MB rar size and 10% par2 for files from 0 to 1024 MB, from 1024 to 5120 MB a rar size of 50 MB will be used, still with a 10% par2 size and finally from 5120 MB onwards a rar size of 100 MB will be used with a 5% par2 size.

External Programs Section

This section defines the location and use of external programs to use. All settings here are optional, if left empty the application environment (PATH) will be used to find the executables.

InactiveProcessTimeoutMinutes

This setting defines how long to wait on process output from an external command. Expecially on very slow (Atom) systems this will need to be increased from the default value of 5 minutes.

RarLocation

The path to the rar executable, leave blank to use the PATH to find this.

RarExtraParameters

Extra parameters to send to the rar command. Be careful with this as a wrong setting here will break a lot of stuff.

ParLocation

The path to the par executable, leave blank to use the PATH to find this.

ParExtraParameters

Extra parameters to send to the par command. Be careful with this as a wrong setting here will break a lot of stuff.
This setting is very useful when multicore par2 is used. A setting of -t-1 will limit the core usage to one core less than available for example.