Browse code
Import from the old rivettracker git repository at sourceforge (amisaph/amisapphire branch)
Clarissa Walker (ami-sapphire) authored on 2014/01/24 14:02:23
Showing 1 changed files
| 1 | 1 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,216 @@ |
| 1 |
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
|
| 2 |
+<html> |
|
| 3 |
+<head> |
|
| 4 |
+<title>RivetTracker Help</title> |
|
| 5 |
+</head> |
|
| 6 |
+<body> |
|
| 7 |
+<center> |
|
| 8 |
+<h3>RivetTracker Help</h3> |
|
| 9 |
+</center> |
|
| 10 |
+<hr> |
|
| 11 |
+<table border="0"> |
|
| 12 |
+<tr bgcolor="#CCCCCC"> |
|
| 13 |
+<td> |
|
| 14 |
+<ul> |
|
| 15 |
+<li><a href="#about">About</a></li> |
|
| 16 |
+<li><a href="#bittorrent">What is BitTorrent?</a></li> |
|
| 17 |
+<li><a href="#tracker">What is a Tracker?</a></li> |
|
| 18 |
+<li><a href="#requirements">Requirements</a></li> |
|
| 19 |
+<li><a href="#installation">RivetTracker Installation</a></li> |
|
| 20 |
+<li><a href="#upgrading">Upgrading</a></li> |
|
| 21 |
+<li><a href="#httpseeding">HTTP Seeding</a></li> |
|
| 22 |
+<li><a href="#help">Support/Help</a></li> |
|
| 23 |
+<li><a href="#contribute">Contribute</a></li> |
|
| 24 |
+<li><a href="#thanksto">Thanks To</a></li> |
|
| 25 |
+</ul> |
|
| 26 |
+</td> |
|
| 27 |
+</tr> |
|
| 28 |
+</table> |
|
| 29 |
+ |
|
| 30 |
+<a name="about"></a> |
|
| 31 |
+<h3>About</h3> |
|
| 32 |
+ |
|
| 33 |
+<p>RivetTracker is a modified version of <a href="http://dehacked.2y.net/BT/">PHPBTTracker Version 1.5rc3</a>, |
|
| 34 |
+written by "DeHackEd". This program provides the same functionality as most other BitTorrent trackers and uses MySQL as the database backend. |
|
| 35 |
+It provides an RSS feed, optional support for HTTP seeding, detailed connection statistics, and much more.</p> |
|
| 36 |
+<p>PHPBTTracker was released under the <a href="http://www.fsf.org/licensing/licenses/info/GPLv2.html">GPLv2 license</a> |
|
| 37 |
+as is this program.</p> |
|
| 38 |
+<p>Some of the images used were provided by the <a href="http://tango.freedesktop.org/">Tango Desktop Project</a>. |
|
| 39 |
+These images are licensed under the |
|
| 40 |
+<a href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.</p> |
|
| 41 |
+ |
|
| 42 |
+<a name="bittorrent"></a> |
|
| 43 |
+<h3>What is BitTorrent?</h3> |
|
| 44 |
+ |
|
| 45 |
+<p>BitTorrent is a Peer to Peer (P2P) communication protocol for sharing files. A client downloads a small |
|
| 46 |
+.torrent file from a website that contains the necessary information to put the whole file or files together. |
|
| 47 |
+This torrent file contains a link to a tracker or trackers that provide information on who else is downloading or |
|
| 48 |
+seeding the file. The term seeder refers to someone who has downloaded the entire file and is uploading parts of |
|
| 49 |
+it to others called leechers. Leechers are people who have started the download and are downloading the file but |
|
| 50 |
+have not finished yet. The beauty of BitTorrent is that it allows people to share files (especially large ones) easily |
|
| 51 |
+without incuring huge hosting costs because of bandwidth limitations. Since all seeders and leechers are constantly uploading |
|
| 52 |
+whatever data they have available, this speeds up the overall distribution of the file. You can start using BitTorrent |
|
| 53 |
+right now by downloading and installing a <a href="http://en.wikipedia.org/wiki/BitTorrent_client">BitTorrent client</a>. |
|
| 54 |
+<p>If you are new to BitTorrent and have not used it before please be careful when initially using it. Sadly, BitTorrent |
|
| 55 |
+has become used heavily for distributing pirated movies, music, and games. That being said, many Linux distributions use |
|
| 56 |
+BitTorrent legally to efficiently release their distribution on a global scale. Many websites use BitTorrent |
|
| 57 |
+for purposes which may be illegal in the country that you live in. Just be careful and watch what you are downloading!</p> |
|
| 58 |
+<p>For more information on the specifics of the BitTorrent protocol you can visit the following websites: |
|
| 59 |
+<ul> |
|
| 60 |
+<li><a href="http://wiki.theory.org/Main_Page">http://wiki.theory.org/Main_Page</a></li> |
|
| 61 |
+<li><a href="http://en.wikipedia.org/wiki/BitTorrent">http://en.wikipedia.org/wiki/BitTorrent</a></li> |
|
| 62 |
+</ul> |
|
| 63 |
+ |
|
| 64 |
+<a name="tracker"></a> |
|
| 65 |
+<h3>What is a Tracker?</h3> |
|
| 66 |
+ |
|
| 67 |
+<p>A <a href="http://en.wikipedia.org/wiki/BitTorrent_tracker">BitTorrent tracker</a> is a piece of software that BitTorrent |
|
| 68 |
+clients communicate with in order to receive information about other people downloading the file. You can think of a tracker |
|
| 69 |
+as a mediator between clients. It doesn't actually transmit the file it just provides information about other people that have it.</p> |
|
| 70 |
+<p>RivetTracker is special because it is built using PHP and MySQL. This means you can easily create a website to share files |
|
| 71 |
+and have a tracker that people around the world are able to connect to. The web-interface makes it easy to navigate and administer.</p> |
|
| 72 |
+ |
|
| 73 |
+<a name="requirements"></a> |
|
| 74 |
+<h3>Requirements</h3> |
|
| 75 |
+ |
|
| 76 |
+ |
|
| 77 |
+<ul> |
|
| 78 |
+<li>A webserver, <a href="http://www.apache.org">Apache</a> is a great one.</li> |
|
| 79 |
+<li>A recent version of <a href="http://www.php.net">PHP.</a></li> |
|
| 80 |
+<li>The <a href="http://www.mysql.org">MySQL Database.</a></li> |
|
| 81 |
+</ul> |
|
| 82 |
+ |
|
| 83 |
+<p>RivetTracker has been tested under <a href="http://www.ubuntu.com">Ubuntu Linux</a>, |
|
| 84 |
+support under Windows is unknown at this time.</p> |
|
| 85 |
+ |
|
| 86 |
+<a name="installation"></a> |
|
| 87 |
+<h3>RivetTracker Installation</h3> |
|
| 88 |
+ |
|
| 89 |
+<p>Installation is very easy, just copy the folder and all the files to your webserver. |
|
| 90 |
+Next, run install.php to create the MySQL database and setup the configuration.</p> |
|
| 91 |
+<a href="./imgs/1.gif"><img src="./imgs/1.gif" border="0" alt="Installation" /></a> |
|
| 92 |
+<p>In this case, I want to create a new database and user that only has access rights to that database. |
|
| 93 |
+For security reasons, it is recommended that you go with the second option.</p> |
|
| 94 |
+<a href="./imgs/2.gif"><img src="./imgs/2.gif" border="0" alt="Database Setup"/></a> |
|
| 95 |
+<p>In this step I provided the installer with a user that can create other users. You will also be required to specify |
|
| 96 |
+the hostname of the MySQL server, user that will be created, and the database name. As you can see in the image |
|
| 97 |
+I have provided all the necessary information. Click install and the script will go through the process of connecting |
|
| 98 |
+to the MySQL server and running the appropriate setup commands.</p> |
|
| 99 |
+<a href="./imgs/3.gif"><img src="./imgs/3.gif" border="0" alt="Configuration File"/></a> |
|
| 100 |
+<p>This section lets you setup the configuration file that stores all your settings about the tracker. Make sure you |
|
| 101 |
+read the directions carefully about each item. It's fairly self-explanatory, just take your time. When you are |
|
| 102 |
+ready click on the create config file button to continue.</p> |
|
| 103 |
+<p>An important note about the hidden tracker feature is that it requires a login by either the admin or upload |
|
| 104 |
+account in order to even view the main torrents page and download them. However, the /torrents folder is NOT |
|
| 105 |
+protected in any way. You will have to go in and create a .htaccess file or something else to protect that folder. |
|
| 106 |
+Also, having the hidden tracker on does not mean this is a private tracker. People will still be able to connect to |
|
| 107 |
+your torrents and use the tracker system if they can get a copy of the torrent. Also, it may be possible if you |
|
| 108 |
+also have scrape support enabled that a client could connect and get information about what files are on your tracker |
|
| 109 |
+through the scrape. Unfortunately, I do not know all the details of how scrape works. If you need a very secure |
|
| 110 |
+tracker, I would suggest checking out the other programs that are available.</p> |
|
| 111 |
+<p>At this point, your installation is finished.</p> |
|
| 112 |
+<p><font color="red"><big>***MAKE SURE YOU DELETE install.php AFTER YOU ARE FINISHED INSTALLING!***</big></font></p> |
|
| 113 |
+<p>Also, make sure that the "torrents" and "rss" folders are writeable by your webserver.</p> |
|
| 114 |
+<p>Click on the link to go to your main statistics page.</p> |
|
| 115 |
+<a href="./imgs/4.gif"><img src="./imgs/4.gif" border="0" alt="Main Page"/></a> |
|
| 116 |
+<p>There are no torrents yet because you have not added them to the database.</p> |
|
| 117 |
+<p>At this point you can start adding torrents to the database by logging in as either the upload user |
|
| 118 |
+or as the administrator. When you get to the add torrent page you should see something like this:</p> |
|
| 119 |
+<a href="./imgs/5.gif"><img src="./imgs/5.gif" border="0" alt="Add Torrent"/></a> |
|
| 120 |
+<p>Simply provide a .torrent file that you have created and specify whether you want one, both, or neither of the |
|
| 121 |
+web seeding features. Most information can be automatically gathered from the torrent file but if you wish, you can |
|
| 122 |
+provide a specific filename and URL for the database to use.</p> |
|
| 123 |
+<p>Click add and you have just added your first torrent to the database. If you go back to the statistics page |
|
| 124 |
+you should see it listed as well as a link to download the torrent file.</p> |
|
| 125 |
+<p>If you want <a href="http://www.azureuswiki.com/index.php/Scrape">scrape</a> functionality, |
|
| 126 |
+check the appropriate box in the configuration settings. It is generally safe to leave this enabled, however, |
|
| 127 |
+there is the possiblity that BitTorrent clients could use this abusively and request this information too much. |
|
| 128 |
+For trackers that serve large numbers of torrents with many users, this will also increase bandwidth usage. |
|
| 129 |
+Scraping is used in order to figure out if a request for additional peers is warranted. This request for peers |
|
| 130 |
+eats up a lot of bandwidth and it is usually better to try to gauge this by asking the tracker via a scrape.</p> |
|
| 131 |
+<p>The speed information is a rough estimate and only gets updated when a client |
|
| 132 |
+connects to the tracker.</p> |
|
| 133 |
+<p>You can now utilize a short announce URL for your tracker. If you enable this feature, you will need the provided |
|
| 134 |
+htaccess file and URL rewriting capabilities enabled and set properly on your server. More info to set it up will be |
|
| 135 |
+located <a href="./htaccess-readme.txt">here.</a></p> |
|
| 136 |
+<p>If you don't like the color scheme you can change it by editing the provided CSS file. |
|
| 137 |
+Go into the admin page and click on "Change CSS File". From there you will be able to create new |
|
| 138 |
+CSS files or edit existing ones.</p> |
|
| 139 |
+<p>The RSS feed that is available is great for people who publish files on a regular basis, for example audio or |
|
| 140 |
+video podcasts.</p> |
|
| 141 |
+<p>If you want to have legal information like a use policy, create a file called "legalterms.txt" in the main directory |
|
| 142 |
+where the index.php file is. Inside the legalterms text file, put your information. Now, when people go to login |
|
| 143 |
+they will have to agree to the terms before it will let them on.</p> |
|
| 144 |
+ |
|
| 145 |
+<a name="upgrading"></a> |
|
| 146 |
+<h3>Upgrading</h3> |
|
| 147 |
+ |
|
| 148 |
+<p>If you are upgrading from a previous installation of RivetTracker there is an easy way to save your |
|
| 149 |
+torrents. Because there might be changes to the database or changes to the configuration file, it is |
|
| 150 |
+much easier just to delete the existing database and installation and start from scratch. Before you do this |
|
| 151 |
+however, go into your current 'torrents' folder and ZIP them all up into one file. Next, delete your current |
|
| 152 |
+database and do a complete reinstall of RivetTracker. After this, go into the admin page and use the batch |
|
| 153 |
+upload system to upload the ZIP file you created. This will load each torrent file in the ZIP one by one. |
|
| 154 |
+It makes it much easier to upload large quantities of torrent files into the database.</p> |
|
| 155 |
+ |
|
| 156 |
+<a name="httpseeding"></a> |
|
| 157 |
+<h3>HTTP Seeding</h3> |
|
| 158 |
+ |
|
| 159 |
+<p>There are two standards for providing <a href="http://wiki.theory.org/BitTorrentSpecification#WebSeeding">web seeding</a> |
|
| 160 |
+in BitTorrent. Web seeding allows an HTTP or FTP server to act as a seeder and provide files to the client. Most of the major |
|
| 161 |
+BitTorrent clients support one standard or the other, or both.</p> |
|
| 162 |
+<p>The first standard was created by BitTornado and you can find the detailed specification |
|
| 163 |
+<a href="http://bittornado.com/docs/webseed-spec.txt">here</a>. It requires that the .torrent file be created with |
|
| 164 |
+an additional list that holds the location or locations of a URL script that provides an interface to the BitTorrent client. |
|
| 165 |
+The benefit of this is that the script is able to limit bandwidth usage and the number of connections to the server requesting the file. |
|
| 166 |
+It also prevents hotlinking directly to the file and abuse. The downside is that only some BitTorrent client support this |
|
| 167 |
+standard.</p> |
|
| 168 |
+<p>The other standard for web seeding is detailed by the GetRight creator <a href="http://getright.com/seedtorrent.html">here</a>. |
|
| 169 |
+This solution also requires that .torrent files include an additional list of direct links to the file or a link to a |
|
| 170 |
+directory where the heirarchy can be re-created. The benefit of this standard is that it does not require any additional |
|
| 171 |
+script be setup or communication with the server that the BitTornado standard does. The downside is that this standard is |
|
| 172 |
+open to abuse from clients potentially hotlinking directly to the file.</p> |
|
| 173 |
+<p>RivetTracker includes support for both standards as well as the scripts required by BitTornado. When you go to add |
|
| 174 |
+a torrent to the database, there is an option to add web seeding support. Simply fill in the required information and when |
|
| 175 |
+the torrent is uploaded this information is added into the .torrent file. This makes migration of old torrent files a snap.</p> |
|
| 176 |
+ |
|
| 177 |
+<a name="help"></a> |
|
| 178 |
+<h3>Support/Help</h3> |
|
| 179 |
+ |
|
| 180 |
+<p>If this document was unable to answer your question or you're stuck on something please visit the RivetCode |
|
| 181 |
+<a href="http://forums.rivetcode.com">forums</a> or <a href="http://www.rivetcode.com/contact/">contact me</a>. |
|
| 182 |
+ |
|
| 183 |
+<a name="contribute"></a> |
|
| 184 |
+<h3>Contribute</h3> |
|
| 185 |
+ |
|
| 186 |
+<p>Want to contribute to future RivetTracker development and releases? There are a couple ways |
|
| 187 |
+in which you can help. First of all, try to find bugs and submit <a href="http://www.rivetcode.com/contact/">bug reports</a>. |
|
| 188 |
+You can also submit suggestions for future versions <a href="http://www.rivetcode.com/contact/">here</a>. |
|
| 189 |
+If you know PHP and are willing to dive into the code, adding features and improving on the project would also be immensely |
|
| 190 |
+helpful. There is a <a href="http://sourceforge.net/projects/rivettracker/">Sourceforge project</a> page that has the bug tracker, |
|
| 191 |
+git repository, and download links. Public git access is available via: |
|
| 192 |
+<pre>git clone git://rivettracker.git.sourceforge.net/gitroot/rivettracker/rivettracker</pre><p> |
|
| 193 |
+ |
|
| 194 |
+ |
|
| 195 |
+<p>Finally, if you want to consider donating a few dollars for further development of this software and future projects that |
|
| 196 |
+would be fantastic. Every little bit helps, thanks!</p> |
|
| 197 |
+<form action="https://www.paypal.com/cgi-bin/webscr" method="post"> |
|
| 198 |
+<input type="hidden" name="cmd" value="_s-xclick"> |
|
| 199 |
+<input type="image" src="https://www.paypal.com/en_US/i/btn/x-click-but04.gif" border="0" name="submit" alt="Make a donation and help support further RivetCode software!" title="Make a donation and help support further RivetCode software!"> |
|
| 200 |
+<img alt="" border="0" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="1" height="1"> |
|
| 201 |
+<input type="hidden" name="encrypted" value="-----BEGIN PKCS7-----MIIHmAYJKoZIhvcNAQcEoIIHiTCCB4UCAQExggEwMIIBLAIBADCBlDCBjjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRQwEgYDVQQKEwtQYXlQYWwgSW5jLjETMBEGA1UECxQKbGl2ZV9jZXJ0czERMA8GA1UEAxQIbGl2ZV9hcGkxHDAaBgkqhkiG9w0BCQEWDXJlQHBheXBhbC5jb20CAQAwDQYJKoZIhvcNAQEBBQAEgYCrOE3S7LR5OwDimRfELsv9ZG7z14706zRg+x8jBQLiltSecWAKIKf+v2MKwsjwpD2wFvtyclEWIADoAuNXJZsxI0Myt+vz49udx+pamfVtSBGjRwQoRbfEr5aw2IzbtKSGcSWB4x3vVd9M/sq1MqTbcUDFbkwdidLcwzCBuPgjFzELMAkGBSsOAwIaBQAwggEUBgkqhkiG9w0BBwEwFAYIKoZIhvcNAwcECJEgkx1sSxmOgIHw+yFB2f0GyCQgCSywBGzq2fypvBo9keMNl9O/i43T+dK4rfLLuoKN+mpD6wpi6jwNNiowGb38XwzqiCy6+PrwiNtLKkUSKSMF+sWxT763cbFGehPNA99i4YkEojQ5by/5hpiPxb9N+G3ud//ygOYw7K6F19oiornqjkqZSAr6i8ADpHoJyWN37xO3O1j/j5xViRL8TFOQFQdEEn4SyA0fDUg/DWDsGye8jtAsrtxOXYyKzkUAC5kmcDux6ecMuS4flH1030H5tkkjpz/oJhV63prg5oehTEwmZy81j2ubtH+RIJZ9WL7SO//OCM77fYMgoIIDhzCCA4MwggLsoAMCAQICAQAwDQYJKoZIhvcNAQEFBQAwgY4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJDQTEWMBQGA1UEBxMNTW91bnRhaW4gVmlldzEUMBIGA1UEChMLUGF5UGFsIEluYy4xEzARBgNVBAsUCmxpdmVfY2VydHMxETAPBgNVBAMUCGxpdmVfYXBpMRwwGgYJKoZIhvcNAQkBFg1yZUBwYXlwYWwuY29tMB4XDTA0MDIxMzEwMTMxNVoXDTM1MDIxMzEwMTMxNVowgY4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJDQTEWMBQGA1UEBxMNTW91bnRhaW4gVmlldzEUMBIGA1UEChMLUGF5UGFsIEluYy4xEzARBgNVBAsUCmxpdmVfY2VydHMxETAPBgNVBAMUCGxpdmVfYXBpMRwwGgYJKoZIhvcNAQkBFg1yZUBwYXlwYWwuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDBR07d/ETMS1ycjtkpkvjXZe9k+6CieLuLsPumsJ7QC1odNz3sJiCbs2wC0nLE0uLGaEtXynIgRqIddYCHx88pb5HTXv4SZeuv0Rqq4+axW9PLAAATU8w04qqjaSXgbGLP3NmohqM6bV9kZZwZLR/klDaQGo1u9uDb9lr4Yn+rBQIDAQABo4HuMIHrMB0GA1UdDgQWBBSWn3y7xm8XvVk/UtcKG+wQ1mSUazCBuwYDVR0jBIGzMIGwgBSWn3y7xm8XvVk/UtcKG+wQ1mSUa6GBlKSBkTCBjjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRQwEgYDVQQKEwtQYXlQYWwgSW5jLjETMBEGA1UECxQKbGl2ZV9jZXJ0czERMA8GA1UEAxQIbGl2ZV9hcGkxHDAaBgkqhkiG9w0BCQEWDXJlQHBheXBhbC5jb22CAQAwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQUFAAOBgQCBXzpWmoBa5e9fo6ujionW1hUhPkOBakTr3YCDjbYfvJEiv/2P+IobhOGJr85+XHhN0v4gUkEDI8r2/rNk1m0GA8HKddvTjyGw/XqXa+LSTlDYkqI8OwR8GEYj4efEtcRpRYBxV8KxAW93YDWzFGvruKnnLbDAF6VR5w/cCMn5hzGCAZowggGWAgEBMIGUMIGOMQswCQYDVQQGEwJVUzELMAkGA1UECBMCQ0ExFjAUBgNVBAcTDU1vdW50YWluIFZpZXcxFDASBgNVBAoTC1BheVBhbCBJbmMuMRMwEQYDVQQLFApsaXZlX2NlcnRzMREwDwYDVQQDFAhsaXZlX2FwaTEcMBoGCSqGSIb3DQEJARYNcmVAcGF5cGFsLmNvbQIBADAJBgUrDgMCGgUAoF0wGAYJKoZIhvcNAQkDMQsGCSqGSIb3DQEHATAcBgkqhkiG9w0BCQUxDxcNMDcwODI5MDMyNjExWjAjBgkqhkiG9w0BCQQxFgQUFcAEoXVkNQqmb7Dx3Htz7+AccEcwDQYJKoZIhvcNAQEBBQAEgYAsc18izZga46hGipu+C9xiR89ucTahC2T1vL8XJa1dqKxg0ii0c75dWJ29/baxATr3VNiQ7KES6d55M4q9cGFzm1lvJjDybVhIjahiED0PygiOqM/B/reCPb79y0DZ07AJaDf0RESyX+SsplTVq3bWFw5VtMryECZkZe8BkF6q4Q==-----END PKCS7-----"> |
|
| 202 |
+</form> |
|
| 203 |
+ |
|
| 204 |
+<a name="thanksto"></a> |
|
| 205 |
+<h3>Thanks To</h3> |
|
| 206 |
+ |
|
| 207 |
+<ul> |
|
| 208 |
+<li>DeHackEd, author of PHPBTTracker</li> |
|
| 209 |
+<li>Bram Cohen, author of BitTorrent</li> |
|
| 210 |
+<li>Everyone on #bittorrent who answered my questions</li> |
|
| 211 |
+<li>The Tango Desktop Project for the excellent icons</li> |
|
| 212 |
+<li>All the testers who reported bugs and gave suggestions</li> |
|
| 213 |
+</ul> |
|
| 214 |
+ |
|
| 215 |
+</body> |
|
| 216 |
+</html> |