BNBT:Documentation:Configuration

From Depthstrike Entertainment
Jump to: navigation, search

Contents

Configuring BNBT

General Configuration Values

allowed_dir

No Default.

Values: Any valid filesystem Folder/Directory reference.

The path (relative or full) to the directory or folder that contains the authorized torrents. Leave blank to authorize ALL torrents.

announce_interval

Default: 1800.

The amount of time (in seconds) that the tracker tells clients to wait between announces.

bind

No Default.

The IP Address assigned to the machine to listen for requests on. Leaving blank specifies to listen on all assigned IP addresses.

bnbt_access_log_dir

No Default.

Values: Any valid filesystem Folder/Directory reference.

The path (relative or full) to the directory or folder to write the access log to. This is not recommended for extended use, as access logs grow quite quickly.

bnbt_allow_comments

Default: 0.

Values: 0,1.

Enable (1) or Disable (0) the posting of comments about torrents.

bnbt_allow_info_link

Default: 0.

Values: 0,1.

Enable (1) or Disable (0) the inclusion of information links with torrents at upload/edit time.

bnbt_allow_scrape

Default: 1.

Values: 0,1.

Enable (1) or Disable (0) the /scrape function on the tracker.

bnbt_allow_search

Default: 1.

Values: 0,1.

Enable (1) or Disable (0) the searching of torrents from the tracker's index page.

bnbt_allow_sort

Default: 1.

Values: 0,1.

Enable (1) or Disable (0) the sorting of torrents by the various categories on the tracker's index page.

bnbt_allow_torrent_downloads

Default: 1.

Values: 0,1.

Enable (1) or Disable (0) the direct downloading of torrents from the tracker.

bnbt_archive_dir

No Default.

Values: Any valid filesystem Folder/Directory reference.

The path (relative or full) to the directory or folder that contains archived torrents.

bnbt_charset

Default: iso-8859-1

Values: Any valid text encoding character set identifier (Reference)

Defines the character set value sent in all Content-Type headers.

bnbt_comment_length

Default: 800

Values: Any integer.

Defines the maximum length of comments made on torrents.

bnbt_comments_file

No Default.

Values: Any valid filesystem file reference.

Defines the file to store comment data.

bnbt_compression_level

Default: 6

Values: 0 (disabled) - 9 (maximum compression)

Defines the level of ZLib compression to use, 0 being disabled, 1 being fastest processed, 9 being best compressed. Values above 9 are assumed to be 9.

bnbt_count_unique_peers

Default: 1

Values: 0,1

Enable (1) or Disable (0) the counting of unique peers on the /info.html interface.

bnbt_debug

Default: 0

Values: 0,1

Enable (1) or Disable (0) the output of debug information and errors/warnings.

bnbt_delete_invalid

Default: 0

Values: 0,1

Enable (1) or Disable (0) the automatic deletion of invalid torrent files.

bnbt_delete_own_torrents

Default: 1

Values: 0,1

Enable (1) or Disable (0) uploaders to delete torrents that they have uploaded.

bnbt_error_log_dir

No Default.

Values: Any valid filesystem Folder/Directory reference.

The path (relative or full) to the directory or folder to write the error log to. Errors from the BNBT console will be logged in this folder.

bnbt_external_torrent_dir

No Default.

Values: Any relative or absolute web-accessible location.

The web location of torrents for downloading. As of Sun Feb 6 05:48:45 2005 UTC in CVS builds, this paramater permits the use of php scripts that use paramaters similar to "?torrentname="

bnbt_file_dir

No Default

Values: Any valid filesystem Folder/Directory reference.

The path (relative or full) to the directory or folder that is represented by the <tracker address>/files interface.

bnbt_file_expires

Default 180

Values: Any integer, minutes.

The number of minutes each browser should cache files accessed through bnbt_file_dir.

bnbt_flush_interval

Default 100

Values: Any integer, messages.

The number of log messages to queue in memory before flushing to disk.

bnbt_force_announce_on_download

Default 0

Values: 0,1

Enable (1) or Disable (0) forcing the announce URL on each torrent as it is downloaded when downloaded through the /torrents/ or the /torrent.html interface. This does NOT affect the announce-list present in the torrent. Requires bnbt_force_announce_url be set.

bnbt_force_announce_url

No Default.

Values: Any valid BT Announce URL.

The announce URL to 'force' on each uploaded torrent at upload-time. This does not affect a torrent's infohash and does not affect the announce-list present in the torrent.

bnbt_guest_access

Default: 67

See User Levels for details

bnbt_max_conns

Default 64

Values: Integer between 2 and 65535

The maximum number of simultaneous connections to permit to be open at a time. Do not change unless you have a real reason to.

bnbt_max_peers_display

Default 500

Values: Any Integer

The maximum number of peers to display on the stats page. Reduce this number if you find that you are having bandwidth issues.

bnbt_max_recv_size

Default 524288

Values: Any Integer

The maximum filesize in bytes for a torrent that is being uploaded.

bnbt_max_torrents

Default 0

Values: Any Integer

The maximum number of torrents to track at any given time. 0 is unlimited.

bnbt_member_access

Default: 79

See User Levels for details

bnbt_name_length

Default 32

Values: Any Integer

The maximum length of usernames.

bnbt_parse_on_upload

Default 1

Values: 0,1

Enable (1) or Disable (0) parsing a torrent for internal information, such as filename, comment, and file contents on upload.

bnbt_per_page

Default 20

Values: Any Integer.

The number of torrents to display per page on the index page.

bnbt_realm

Default "BNBT"

Values: Any valid HTTP Authentication realm.

The authentication realm passed to a browser when logging in. Once set, DO NOT CHANGE IT. Passwords WILL become invalid if you do change this after user accounts are made.

bnbt_refresh_static_interval

Default: 10

Values: Any integer

The amount of time, in minutes, between updates of static datafiles such as bnbt_static_header and bnbt_static_footer

bnbt_refresh_fast_cache_interval

Default: 30

Values: Any Integer

The amount of time, in seconds, to wait before updating internal caches of index and scrape data. When processing requests for index and scrape, if the amount of time since the last request for one of them is greater than this interval, the data is refreshed. If less, it is not.

bnbt_robots_txt

No Default

Values: Any valid filesystem file reference reference.

The path (relative or full) to the file to return to clients when /robots.txt is called.

bnbt_show_added

Default 1

Values: 0,1

Enable (1) or Disable (0) displaying of dates and times when each torrent was uploaded on the index page.

bnbt_show_average_dl_rate

Default 0

Values: 0,1

Enable (1) or Disable (0) displaying of average peer download rates on the stats page.

bnbt_show_average_left

Default 0

Values: 0,1

Enable (1) or Disable (0) displaying of average left percentages on the index page.

bnbt_show_average_ul_rate

Default 0

Values: 0,1

Enable (1) or Disable (0) displaying of average peer upload rates on the stats page.

bnbt_show_completed

Default 0

Values: 0,1

Enable (1) or Disable (0) displaying of the number of times each torrent has been completed on the index page.

bnbt_show_file_comment

Default 1

Values: 0,1

Enable (1) or Disable (0) displaying of the torrent's internal comment in the torrent details page.

bnbt_show_file_contents

Default 0

Values: 0,1

Enable (1) or Disable (0) displaying of the torrent's files in the torrent details page


bnbt_show_gen_time

Default 1

Values: 0,1

Enable (1) or Disable (0) displaying of page generation times on some pages.

bnbt_show_info_hash

Default 0

Values: 0,1

Enable (1) or Disable (0) displaying of info hashes on the index page.

bnbt_show_left_as_progress

Default 1

Values: 0,1

Enable (1) or Disable (0) displaying of the 'left percentages' as 'progress percentages'.

bnbt_show_max_left

Default 0

Values: 0,1

Enable (1) or Disable (0) displaying of maximum left percentages on the index page.

bnbt_show_min_left

Default 0

Values: 0,1

Enable (1) or Disable (0) displaying of minimum left percentages on the index page.

bnbt_show_num_files

Default 1

Values: 0,1

Enable (1) or Disable (0) displaying of the number of files (inside each torrent) on the index page.

bnbt_show_share_ratios

Default 1

Values: 0,1

Enable (1) or Disable (0) displaying of share ratios from the current session on the stats page.

bnbt_show_size

Default 1

Values: 0,1

Enable (1) or Disable (0) displaying of torrent sizes on the index page.

bnbt_show_stats

Default 1

Values: 0,1

Enable (1) or Disable (0) torrent statistics pages.

bnbt_show_transferred

Default 0

Values: 0,1

Enable (1) or Disable (0) displaying of the total bytes transferred on each torrent on the index page (total bytes transferred is calculated as completed * size).

bnbt_show_uploader

Default 0

Values: 0,1

Enable (1) or Disable (0) displaying of the username of the uploader on the index page.

bnbt_static_footer

No default

Values: Any valid filesystem file reference

The local location of the file to display at the bottom of the index page.

bnbt_static_header

No default

Values: Any valid filesystem file reference

The local location of the file to display at the top of the index page.

bnbt_style_sheet

No default

Values: Any valid web-accessible CSS file

The web-location of the CSS file that controls the look of the tracker. BNBT CSS Classes and information

bnbt_tag_file

Default: tags.bnbt

Values: Any valid filesystem file reference

The local location of the file to store tags, names, uploaders, and info links.

bnbt_upload_dir

No default

Values: Any valid filesystem Folder/Directory reference

The local location of the folder/directory to place torrents uploaded with the torrent uploader interface (/upload.html - This is often set the same as allowed_dir).

bnbt_users_file

Default: users.bnbt

Values: Any valid filesystem file reference

The local location of the file to store usernames, hashed passwords, access levels, and creation dates and times.

bnbt_users_per_page

Default: 50

Values: Any Integer

The number of users to display per page on the users page.

dfile

Default dstate.bnbt

Values: Any valid filesystem file reference

The local location of the file to store downloader and completes data.

downloader_timeout_interval

Default: 2700

Values: Any integer, measured in seconds

The number of seconds to wait between expiring timed out peers (this should be greater than announce_interval).

image_bar_fill

No Default

Values: Any Web-accessible image.

The location of the image to use in progress graphs to display the amount completed.

image_bar_trans

No Default

Values: Any Web-accessible image.

The location of the image to use in progress graphs to display the amount remaining.

keep_dead

Default 0

Values: 0,1

Enable (1) or Disable (0) displaying of torrents with 0 seeders and 0 leechers on the index page.

max_give

Default: 200

Values: Any Integer

The maximum number of peers to include with the announce response, overrides the numwant= request paramater if numwant is higher.

min_request_interval

Default 18000

Values: Any Integer, measured in seconds.

The number of seconds each client should wait between scrapes, returned to a client in the scrape response.

parse_allowed_interval

Default 0

Values: Any Integer, measured in minutes.

The number of minutes to wait between parsing the allowed_dir or 0 to disable parsing the allowed dir (often used with bnbt_parse_on_upload when 0). Use nonzero values when using external uploader scripts.

port

Default: 6969

Values: Any integer between 1 and 65535

The port for the to listen on. Recommend keeping the port numbers above 1024. Current CVS builds support multiple listen ports.

response_size

Default 50

Values: Any Integer

The default number of peers to include with the announce response when the numwant paramater is not present. When numwant is present and is lower than max_give the value in numwant overrides response_size. Known issues in tracker_announce.cpp may cause the numwant paramater to be ignored. Current CVS builds have fixes for this issue.

save_dfile_interval

Default: 300

Values: Any Integer, measured in seconds

The number of seconds to wait between saving the internal database to the dfile.

show_names

Default 1

Values: 0,1

Enable (1) or Disable (0) displaying of names on the index page.

socket_timeout

Default: 15

Values: Any Integer, measured in seconds

The number of seconds to wait before closing inactive connections.

MySQL Configuration Values

mysql_database

Default: bnbt

Values: Any Valid MySQL Database name.

The database BNBT will use when accessing the MySQL server.

mysql_host

No default (blank is equal to localhost)

Values: Any valid MySQL server address (not including the listen port)

The MySQL server BNBT will access

mysql_override_dstate

Default 0

Values: 0,1

Enable (1) or Disable (0) per peer queries. Please see the BNBTPHP Documentation for details.

mysql_password

No default

Values: Any Valid MySQL Password

The password BNBT will use when accessing the MySQL server.

mysql_port

Default 0 (0 is equal to 3306, MySQL's Default port)

Values: Any Integer between 0 and 65535

The port BNBT will connect to when accessing the MySQL server.

mysql_refresh_allowed_interval

Default 0

Values: Any Integer, Measured in seconds.

The number of seconds to wait between cycles for refreshing the local copy of the ALLOWED table from MySQL. Please see the BNBTPHP Documentation for details.

mysql_refresh_stats_interval

Default 600

Values: Any Integer, Measured in seconds.

The number of seconds to wait between refreshing the TORRENTS table in MySQL. Please see the BNBTPHP Documentation for details.

mysql_user

No default

Values: Any Valid MySQL Username

The user BNBT will use when accessing the MySQL server.

RSS Configuration Values

bnbt_rss_channel_copyright

No Default

Values: Any valid RSS Copyright text

The copyright information for your rss feed in plain text.

bnbt_rss_channel_description

Default: BitTorrent RSS Feed for BNBT

Values: Any valid RSS feed description text.

A description of your rss feed in plain text.

bnbt_rss_channel_image_height

Default: 0 (automatic)

Values: Any Integer, Recommended below 400, measured in pixels.

The height of your rss feed's channel image in pixels that should be less that 400 (and spec uses a default of 31). Use 0 if you don't want to specify.

bnbt_rss_channel_image_url

No Default

Values: Any valid web location pointing to an image.

The online location of the channel image, use either /files/... or http://.., that is a GIF, JPEG or PNG image. If it starts with a /files/ it will add bnbt_rss_channel_link before it.

bnbt_rss_channel_image_width

Default: 0 (automatic)

Values: Any Integer, Recommended below 144, measured in pixels.

The width of your rss feed's channel image in pixels that should be less that 144 (and spec uses a default of 88). Use 0 if you don't want to specify.

bnbt_rss_channel_language

Default: en-us

Values: Any valid language code (Language Code List)

The character code of the language the rss feed is written in.

bnbt_rss_channel_link

Also Referenced as bnbt_rss_tracker_url Default: http://localhost:6969

Values: The FULL URI to your tracker's web interface

This Value MUST be changed to work properly; The URL of your tracker that starts with http://, contains the hostname and port, and ends with a slash ( / ).

bnbt_rss_channel_title

Default: My BNBT RSS Feed

Values: Any valid RSS Feed title.

The name of your rss feed in plain text.

bnbt_rss_channel_ttl

Default: 60

Values: Any Integer, measured in minutes.

The time to live value in minutes of your rss feed, i.e. how often can the rss readers check your feed for content.

bnbt_rss_file

No Default

Values: Any valid filesystem file reference pointing at the output file for the RSS feed.

The file to output your rss feed to, which should use .xml or .rss. Must be set for rss feature to be enabled.

bnbt_rss_file_mode

Default: 0

Values: 0, 1, 2

Rss Feed Output Mode. 0 - single feed file. 1, One feed per category, 2, Single feed for all categories plus one feed per category.

bnbt_rss_interval

Default: 30

Values: Any Integer, measured in minutes.

How often in minutes that your rss feed is acually generated.If set to 0 then it will only update rss on startup and via the admin link.

bnbt_rss_limit

Default: 25

Values: Any integer. 0 means no limit.

How many items (torrents) to output in your rss feed, 0 means all items.

bnbt_rss_online_dir

No Default

Values: Any valid web location pointing to the directory that contains the RSS feed files.

The online location of your rss feeds if using bnbt_rss_file_mode mode 1 or 2 and want links to the rss feeds on index page.