codex-storage
/
deluge
mirror of https://github.com/codex-storage/deluge.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix mkdocs links warnings

This commit is contained in:
Calum Lind 2024-07-08 11:35:55 +01:00
parent 2d3954a946
commit 28277f8d12
No known key found for this signature in database
GPG Key ID: 90597A687B836BA3
47 changed files with 197 additions and 189 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -23,6 +23,14 @@ Live reloading will refresh the served pages modifying mkdocs.yml and
markdown pages. Changes to any `overrides` files requires restarting
docker server.
### Mkdocs Plugins
[**Awesome pages plugin**](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin)
This pages plugin solves the issue where mkdocs only includes the specific pages listed in the config nav section which means it would be cumbersome to list every pages and it's location. To help build the navigation this plugin allows using ellipsis with filters to indicate all other pages to include in sections.
In future if all pages are listed in config nav section this plugin would be redundant.
### Build site
```
@ -36,13 +44,12 @@ The build output will be in `site` directory.
The `overrides` directory contains the files to set a custom homepage
and custom header for the site.
## Forum
The Deluge forum is provided by phpBB. It uses a MySQL database and is
installed in the following location:
* `/var/www/forum.deluge-torrent.org/htdocs/`
- `/var/www/forum.deluge-torrent.org/htdocs/`
The Deluge navigation header is setup in a custom phpBB style theme
named `deluge_stormyday_3.3` based on the default prosilver theme.
@ -50,22 +57,21 @@ named `deluge_stormyday_3.3` based on the default prosilver theme.
Note: Changes made to live site will not be reflected until a `Purge Cache`
action is performed from admin control panel.
## CGIT
cgit is a web interface to the git repos.
* Installation: `/var/www/git.deluge-torrent.org/`
* cgit config: `/etc/cgitrc`
* Apache config: `/etc/httpd/sites-enabled/git.deluge-torrent.org.conf`
- Installation: `/var/www/git.deluge-torrent.org/`
- cgit config: `/etc/cgitrc`
- Apache config: `/etc/httpd/sites-enabled/git.deluge-torrent.org.conf`
### Custom header
The cgit config links to the following files to provide the Deluge
header nav bar:
* `/var/www/deluge-torrent.org/htdocs/cgit-head-include`
* `/var/www/deluge-torrent.org/htdocs/deluge_header_nav.html`
- `/var/www/deluge-torrent.org/htdocs/cgit-head-include`
- `/var/www/deluge-torrent.org/htdocs/deluge_header_nav.html`
## Other Root files
@ -74,10 +80,10 @@ header nav bar:
These two PHP scripts provide the application with a test port option to
verify network connectivity.
* test-port.php
* test_port.php
- test-port.php
- test_port.php
### Http Downloader
For unit testing purposes there is a `httpdownloader.php` to test
downloading different types of files.
downloading different types of files.

2
docs/about.md
View File

@ -43,4 +43,4 @@ Deluge has a wide-array of features, including:
* Other [libtorrent features](http://www.rasterbar.com/products/libtorrent/features.html)
* And much more!
[Download](/download) the latest release and give it a try!
[Download](/download.md) the latest release and give it a try!

BIN
docs/assets/screenshots/daemon_massif_visualizer.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 230 KiB

BIN
docs/assets/screenshots/runsnake.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 121 KiB

BIN
docs/assets/screenshots/runsnake_after_optimizations.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 189 KiB

10
docs/contributing/bugreporting.md
View File

@ -2,7 +2,7 @@
- Install the latest version of Deluge.
- Check the **[Frequently Asked Questions](/faq)**.
- Check the **[Frequently Asked Questions](/faq.md)**.
## Search for Existing Issues
@ -28,8 +28,8 @@ You will need the following information when reporting a bug, Deluge and libtorr
- Version Information:
- [Deluge version](/troubleshooting#delugeversion).
- [libtorrent version](/troubleshooting#libtorrentversion).
- [Deluge version](/troubleshooting.md#deluge-version).
- [libtorrent version](/troubleshooting.md#libtorrent-version).
- Operating System and version.
- Browser and version _(if using WebUI)_.
@ -39,9 +39,9 @@ You will need the following information when reporting a bug, Deluge and libtorr
- Precise steps to reproduce the bug.
- [Deluge Logs](/troubleshooting#enable-deluge-logging) (`error` level is usually fine in first instance).
- [Deluge Logs](/troubleshooting.md#enable-deluge-logging) (`error` level is usually fine in first instance).
- Information of any errors or traces.
- [Config](/faq#wheredoesdelugestoreitssettings) files.
- [Config](/faq.md#where-does-deluge-store-its-settingsconfig) files.
- Screenshots and screencasts are helpful for GUI issues.
_Note: If you are using Client and Daemon you may need version or logs from both._

2
docs/development/building/libtorrent.md
View File

@ -127,7 +127,7 @@ rm -f /.swapfile
```
bootstrap.bat
```
Due to a [boost bug](https://svn.boost.org/trac/boost/ticket/10817) with `VC for Python`, need to edit `project-config.jam` in boost folder to the following:
Due to a [boost bug](https://svn.boost.org/trac/boosthttps://dev.deluge-torrent.org/ticket/10817) with `VC for Python`, need to edit `project-config.jam` in boost folder to the following:
```
using msvc : : : <setup>"%USERPROFILE%\\AppData\\Local\\Programs\\Common\\Microsoft\\Visual C++ for Python\\9.0\\vcvarsall.bat" ;

4
docs/development/git/gitrepo.md
View File

@ -2,9 +2,9 @@
Deluge's source code is always available through our [Git repository](http://git.deluge-torrent.org/deluge).
To get a copy of the code, you will need to clone it from the repository then see the [Install from source](/installing/source) guide.
To get a copy of the code, you will need to clone it from the repository then see the [Install from source](/installing/source.md) guide.
For more in-depth git usage see [GitTips](/development/git/gittips).
For more in-depth git usage see [GitTips](/development/git/gittips.md).
This guide uses commands which are meant to be typed at a command prompt, but most will be available from a GUI Git client.

6
docs/development/git/gittips.md
View File

@ -202,12 +202,12 @@ To differentiate commit changes at a glance, the subject of commits for specific
If the commit fix/closes a ticket, include the number:
`[[#1001](/ticket/1001)] Add support for magnet uris`
`[[#1001](https://dev.deluge-torrent.org/ticket/1001)] Add support for magnet uris`
A limited number of tags may be combined, such as
`[[#1002](/ticket/1002)] [GTKUI] Fix the files tab context menu not being displayed`
`[[#1002](https://dev.deluge-torrent.org/ticket/1002)] [GTKUI] Fix the files tab context menu not being displayed`
`[[#2250](/ticket/2250)] [Core] [GTKUI] Add method remove_torrents to core`
`[[#2250](https://dev.deluge-torrent.org/ticket/2250)] [Core] [GTKUI] Add method remove_torrents to core`

20
docs/development/index.md
View File

@ -1,6 +1,6 @@
# Development
[Deluge Project Goals](/projectgoals)
[Deluge Project Goals](/contributing/projectgoals.md)
## Source Code
@ -11,8 +11,8 @@ The latest and greatest versions of Deluge are here:
Guides:
- [Installing from Source](/installing/source)
- [Using git repository](/development/git/gitrepo)
- [Installing from Source](/installing/source.md)
- [Using git repository](/development/git/gitrepo.md)
## Bug Tracking
@ -24,7 +24,7 @@ Guides:
### Coding
- [UI Client](/development/1.3/uiclient)
- [UI Client](/development/uiclient.md)
### Testing
@ -32,18 +32,18 @@ Guides:
### Plugins
- [Plugin Development](/development/plugins)
- [Plugin Ideas](/development/pluginideas)
- [Available Plugins](/plugins)
- [Plugin Development](/development/plugins/index.md)
- [Plugin Ideas](/development/plugins/pluginideas.md)
- [Available Plugins](/plugins/index.md)
### Performance
- [Profiling](/development/profiling)
- [Vast number of torrents](/development/vast_amount_of_torrents)
- [Profiling](/development/profiling.md)
- [Vast number of torrents](/development/vast_amount_of_torrents.md)
## Packaging
- [Packaging](/development/packaging)
- [Packaging](/development/packaging/index.md)
## Contributing

2
docs/development/packaging/osx.md
View File

@ -31,7 +31,7 @@
jhbuild build meta-gtk-osx-themes
jhbuild build gtk-quartz-engine
```
* *Note:* [Quartz patch](https://www.xpra.org/trac/attachment/ticket/533/quartz-style-fix.patch) if build error: `'height' is uninitialized`.
* *Note:* [Quartz patch](https://www.xpra.org/trac/attachmenthttps://dev.deluge-torrent.org/ticket/533/quartz-style-fix.patch) if build error: `'height' is uninitialized`.
1. [Bundler](https://wiki.gnome.org/Projects/GTK%2B/OSX/Bundling) for Packaging Deluge.
```

2
docs/development/plugins/index.md
View File

@ -20,7 +20,7 @@ Conceptually you'll want to view your plugin as a collection of separate program
## Getting Started
The easiest way to get started is to use the [create_plugin.py](http://git.deluge-torrent.org/deluge/plain/deluge/scripts/create_plugin.py?h=1.3-stable) script in the appropriate branch in our [GitRepo](/gitrepo). Alternatively, you can use other plugins as a template if you prefer.
The easiest way to get started is to use the [create_plugin.py](http://git.deluge-torrent.org/deluge/plain/deluge/scripts/create_plugin.py?h=1.3-stable) script in the appropriate branch in our [GitRepo]/development/git/gitrepo.md). Alternatively, you can use other plugins as a template if you prefer.
Running the script:

0
docs/development/pluginideas.md → docs/development/plugins/pluginideas.md
View File

6
docs/development/plugins/quickstart.md
View File

@ -47,12 +47,12 @@ Rename the egg to <plugin-name>.egg and share it,
## alerts
* registering for a "torrent_finished" alert : http://forum.deluge-torrent.org/viewtopic.php?f=9&t=8155#p37775
* [Plugin Alerts](/development/plugins/alerts)
* [Plugin Alerts](/development/plugins/alerts.md)
## signals
* [Plugin Signals](/development/plugins/signals)
* [Plugin Signals](/development/plugins/signals.md)
# Examples
* [Plugin WebUI Examples](/development/plugins/webui/examples)
* [Plugin WebUI Examples](/development/plugins/webui/examples.md)

7
docs/development/profiling.md
View File

@ -25,7 +25,7 @@ Lets open this with [RunSnakeRun](http://www.vrplumber.com/programming/runsnaker
Below is an example of the profile results for version 1.3.5 after connecting to a daemon with 2000 torrents.
![](/deluge_runsnake.png)
![](/assets/screenshots/runsnake.png)
A very interresting entry is the update_view in torrentview.py. This function is called 23 times where the total time spent in the function is 27 seconds. Each call takes 1.18 seconds. For the short time the client was connected this is a lot of time!
@ -167,7 +167,7 @@ Lets do a new profile with the changes to the code:
python -m cProfile -o deluge.profile deluge -l deluge.log -L info
```
![](/deluge_runsnake_after_optimizations.png)
![](/assets/screenshots/runsnake_after_optimizations.png)
We can now see how update_view has dropped significantly on the list. Each call to update_view now takes 0.37 seconds on average compared to 1.18 in the original code.
@ -202,6 +202,7 @@ Lets open that with [massif-visualizer](https://projects.kde.org/projects/extrag
massif-visualizer massif.out.26034
```
<img src="Development Profiling/Deluge_daemon_massif_visualizer.jpg" width=800px>
![](/assets/screenshots/daemon_massif_visualizer.jpg)
Here we see a nice graph showing the memory usage at snapshots taken at regular intervals. It's clear that a lot of the memory used by the daemon is in fact used by libtorrent. It's possible to get a more detailed view of the memory usage of the different categories shown in the list on the right.

0
docs/development/uiclient1.md → docs/development/uiclient.md
View File

32
docs/development/vast_amount_of_torrents.md
View File

@ -13,35 +13,35 @@ Deluge v1.3 handles hundreds of torrents fairly well. The GTKUI uses a lot of CP
When the torrent list reaches 1000 torrents, the CPU usage gets more and more noticable, the more torrents the slower it gets.
The following patches have been applied to 1.3:
* [Cache tracker icons in gtkui ([#2248](/ticket/2248))](http://dev.deluge-torrent.org/ticket/2248) [git commit](http://git.deluge-torrent.org/deluge/commit/?h=1.3-stable&id=36a78d8f219f) (gtkui)
* [Small (but significant) speed optimizations to the torrentview ([#2259](/ticket/2259))](http://dev.deluge-torrent.org/ticket/2259) [git commit](http://git.deluge-torrent.org/deluge/commit/?h=1.3-stable&id=a0ae3ebfce826980d08f6e75ec62a48e39cd5b41) (gtkui) (smaller version of [#2184](ticket/2184) for 1.3 branch)
* [Speed optimizations to the torrentview in GTKUI ([#2184](/ticket/2184))](http://dev.deluge-torrent.org/ticket/2184), [git commit](http://git.deluge-torrent.org/deluge/commit/?h=1.3-stable&id=5dba83853308482827aaecd1be1e79be97e30d15)
* [Cache tracker icons in gtkui ([#2248](https://dev.deluge-torrent.org/ticket/2248))](http://dev.deluge-torrent.orghttps://dev.deluge-torrent.org/ticket/2248) [git commit](http://git.deluge-torrent.org/deluge/commit/?h=1.3-stable&id=36a78d8f219f) (gtkui)
* [Small (but significant) speed optimizations to the torrentview ([#2259](https://dev.deluge-torrent.org/ticket/2259))](http://dev.deluge-torrent.orghttps://dev.deluge-torrent.org/ticket/2259) [git commit](http://git.deluge-torrent.org/deluge/commit/?h=1.3-stable&id=a0ae3ebfce826980d08f6e75ec62a48e39cd5b41) (gtkui) (smaller version of [#2184](https://dev.deluge-torrent.org/ticket/2184) for 1.3 branch)
* [Speed optimizations to the torrentview in GTKUI ([#2184](https://dev.deluge-torrent.org/ticket/2184))](http://dev.deluge-torrent.orghttps://dev.deluge-torrent.org/ticket/2184), [git commit](http://git.deluge-torrent.org/deluge/commit/?h=1.3-stable&id=5dba83853308482827aaecd1be1e79be97e30d15)
# State of git-develop (To be v2)
git-develop has been tested and works well with 2-3000 torrents. Currently the biggest problem is that to make libtorrent v0.16.X handle that many active torrents, the settings *active_dht_limit*, *active_tracker_limit*, *active_lsd_limit* must be set. This is currently not implemented in git-develop, but applying the patch proposed in [#2257](/ticket/2257) should solve this. this can also be fixed by using the ltconfig plugin found in the [list of plugins](http://dev.deluge-torrent.org/wiki/plugins).
git-develop has been tested and works well with 2-3000 torrents. Currently the biggest problem is that to make libtorrent v0.16.X handle that many active torrents, the settings *active_dht_limit*, *active_tracker_limit*, *active_lsd_limit* must be set. This is currently not implemented in git-develop, but applying the patch proposed in [#2257](https://dev.deluge-torrent.org/ticket/2257) should solve this. this can also be fixed by using the ltconfig plugin found in the [list of plugins](http://dev.deluge-torrent.org/wiki/plugins).
The following patches have already been applied which improves the speed of Deluge with many torrents greatly:
## GTKUI patches==
* [Speed optimizations to the torrentview in GTKUI ([#2184](/ticket/2184))](http://dev.deluge-torrent.org/ticket/2184), [git commit](http://git.deluge-torrent.org/deluge/commit/?id=b4f5e78a775503a5501e2eba7eee73dfa0e1955a)
* [Cache tracker icons in gtkui ([#2248](/ticket/2248))](http://dev.deluge-torrent.org/ticket/2248) ([git commit](http://git.deluge-torrent.org/deluge/commit/?id=463ac0c07eda1b33b145e1b9be7edbc0981815a99))
* [Speed optimizations to sessionproxy ([#2285](/ticket/2285))](http://dev.deluge-torrent.org/ticket/2285) [git commit](http://git.deluge-torrent.org/deluge/commit/?h=develop&id=5503f9047)
* [Add caching to the data-funcs in ui/gtkui/torrentview_data_funcs.py](http://dev.deluge-torrent.org/ticket/1885) [git commit](http://dev.deluge-torrent.org/changeset/8ecc0e11a79d92)
* [Speedup removing multiple torrents from core ([#2250](/ticket/2250))](http://dev.deluge-torrent.org/ticket/2250) (gtkui)
* [Speed optimizations to the torrentview in GTKUI ([#2184](https://dev.deluge-torrent.org/ticket/2184))](http://dev.deluge-torrent.orghttps://dev.deluge-torrent.org/ticket/2184), [git commit](http://git.deluge-torrent.org/deluge/commit/?id=b4f5e78a775503a5501e2eba7eee73dfa0e1955a)
* [Cache tracker icons in gtkui ([#2248](https://dev.deluge-torrent.org/ticket/2248))](http://dev.deluge-torrent.orghttps://dev.deluge-torrent.org/ticket/2248) ([git commit](http://git.deluge-torrent.org/deluge/commit/?id=463ac0c07eda1b33b145e1b9be7edbc0981815a99))
* [Speed optimizations to sessionproxy ([#2285](https://dev.deluge-torrent.org/ticket/2285))](http://dev.deluge-torrent.orghttps://dev.deluge-torrent.org/ticket/2285) [git commit](http://git.deluge-torrent.org/deluge/commit/?h=develop&id=5503f9047)
* [Add caching to the data-funcs in ui/gtkui/torrentview_data_funcs.py](http://dev.deluge-torrent.orghttps://dev.deluge-torrent.org/ticket/1885) [git commit](http://dev.deluge-torrent.org/changeset/8ecc0e11a79d92)
* [Speedup removing multiple torrents from core ([#2250](https://dev.deluge-torrent.org/ticket/2250))](http://dev.deluge-torrent.orghttps://dev.deluge-torrent.org/ticket/2250) (gtkui)
## Core patches
* [Speed optimizations to the daemon](http://dev.deluge-torrent.org/ticket/2255) [git commit](http://git.deluge-torrent.org/deluge/commit/?id=8c106ce8c4c0794ddd63e8e8f98b097221a56a52)
* [Speedup set_prioritize_first_last in torrent.py ([#2246](/ticket/2246))](http://dev.deluge-torrent.org/ticket/2246), [git commit](http://git.deluge-torrent.org/deluge/commit/?id=6313ff19b322a2801c633324bb0d77dc4f59b9a1) (mainly on startup)
* [Move cleanup of prev_status from torrent.py to torrentmanager.py ([#2379](/ticket/2379))](http://dev.deluge-torrent.org/ticket/2379) [git commit](http://dev.deluge-torrent.org/changeset/feaeee0379)
* [Application layer protocol for transfering RPC messages + utf8 decoding error ([#2116](/ticket/2116))](http://dev.deluge-torrent.org/ticket/2116), [git commit](http://git.deluge-torrent.org/deluge/commit/?id=8e7432e71c80a47c96bf48c07535ec1991efe1d9) (rpc communication between daemon and clients)
* [Speed up adding multiple torrents ([#2406](/ticket/2406))](http://dev.deluge-torrent.org/ticket/2406) (core/gtkui)
* [Speed optimizations to the daemon](http://dev.deluge-torrent.orghttps://dev.deluge-torrent.org/ticket/2255) [git commit](http://git.deluge-torrent.org/deluge/commit/?id=8c106ce8c4c0794ddd63e8e8f98b097221a56a52)
* [Speedup set_prioritize_first_last in torrent.py ([#2246](https://dev.deluge-torrent.org/ticket/2246))](http://dev.deluge-torrent.orghttps://dev.deluge-torrent.org/ticket/2246), [git commit](http://git.deluge-torrent.org/deluge/commit/?id=6313ff19b322a2801c633324bb0d77dc4f59b9a1) (mainly on startup)
* [Move cleanup of prev_status from torrent.py to torrentmanager.py ([#2379](https://dev.deluge-torrent.org/ticket/2379))](http://dev.deluge-torrent.orghttps://dev.deluge-torrent.org/ticket/2379) [git commit](http://dev.deluge-torrent.org/changeset/feaeee0379)
* [Application layer protocol for transfering RPC messages + utf8 decoding error ([#2116](https://dev.deluge-torrent.org/ticket/2116))](http://dev.deluge-torrent.orghttps://dev.deluge-torrent.org/ticket/2116), [git commit](http://git.deluge-torrent.org/deluge/commit/?id=8e7432e71c80a47c96bf48c07535ec1991efe1d9) (rpc communication between daemon and clients)
* [Speed up adding multiple torrents ([#2406](https://dev.deluge-torrent.org/ticket/2406))](http://dev.deluge-torrent.orghttps://dev.deluge-torrent.org/ticket/2406) (core/gtkui)
Proposed patches:
* [Allow setting of active_dht_limit, active_tracker_limit and active_lsd_limit. Fix bugs. ([#2257](/ticket/2257))](http://dev.deluge-torrent.org/ticket/2257) (daemon)
* [Allow setting of active_dht_limit, active_tracker_limit and active_lsd_limit. Fix bugs. ([#2257](https://dev.deluge-torrent.org/ticket/2257))](http://dev.deluge-torrent.orghttps://dev.deluge-torrent.org/ticket/2257) (daemon)
Other issues that need investigation:
* Pausing/resuming multiple torrents is very slow. This is probably because when a torrent changes state, a lot of operations are done (event listeners in GUI presumable), so with hundreds of torrents changing state the result is too much work needing to be done.
* CPU usage on an idle daemon can still be around 5% ([[#1490](/ticket/1490)](http://dev.deluge-torrent.org/ticket/1490)).
* CPU usage on an idle daemon can still be around 5% ([[#1490](https://dev.deluge-torrent.org/ticket/1490)](http://dev.deluge-torrent.orghttps://dev.deluge-torrent.org/ticket/1490)).
* Reducing the number of calls (executions) torrent.update_state during startup (loading torrents)
* Investigate if libtorrent.file_progress is a bottleneck

4
docs/download.md
View File

@ -4,7 +4,7 @@
<img src=https://deluge-torrent.org/images/ubuntu-logo.png left, link=>
<img src=https://deluge-torrent.org/images/spacer.gif left, link=, width=7, height=20>
[Ubuntu](https://tinyurl.com/installdeluge), also [Deluge PPA](/installing/linux/ubuntu#AddDelugePPARepository)
[Ubuntu](https://tinyurl.com/installdeluge), also [Deluge PPA](/installing/linux/ubuntu.md#deluge-ppa-repository)
<img src=https://deluge-torrent.org/images/debian-logo.png left, link=>
<img src=https://deluge-torrent.org/images/spacer.gif left, link=, width=10, height=20>
@ -62,4 +62,4 @@ Deluge 2.0 packages are not yet available, please see [docs](https://deluge.read
## Source
[_Install from source_](/installing/source) using [release tarballs](https://ftp.osuosl.org/pub/deluge/source/?c=m;o=d) or [git repository](/development/git/gitrepo/).
[_Install from source_](/installing/source.md) using [release tarballs](https://ftp.osuosl.org/pub/deluge/source/?c=m;o=d) or [git repository](/development/git/gitrepo.md).

40
docs/faq.md
View File

@ -6,18 +6,18 @@
### Is Deluge Free? Can I get the source?
Yes, Deluge is Free Software, as defined by the Free Software Foundation, and is released under the GPL, giving our users complete freedom. The source code is available in the [download section](/download). Our GPL nature allows you to be 100% sure that our program will never “spy” on your activities. Closed-source BitTorrent clients cannot make that same claim.
Yes, Deluge is Free Software, as defined by the Free Software Foundation, and is released under the GPL, giving our users complete freedom. The source code is available in the [download section](/download.md). Our GPL nature allows you to be 100% sure that our program will never “spy” on your activities. Closed-source BitTorrent clients cannot make that same claim.
### How do I install Deluge?
[Installing](/installing)
[Installing](/installing/index.md)
### I have an issue starting or using Deluge.
See [Troubleshooting](/troubleshooting) and [Bug Reporting](/contributing/bugreporting)
See [Troubleshooting](/troubleshooting.md) and [Bug Reporting](/contributing/bugreporting.md)
### How to start the various user-interfaces?
See [UI specific questions](/faq#user-interface-specific)
See [UI specific questions](/faq.md#user-interface-specific)
### How do I set Deluge as my default BitTorrent program?
@ -48,7 +48,7 @@ Users can reset the Magnet association with:
* Put `about:config` into address bar and change `network.protocol-handler.expose.magnet` to `false`.
You will be prompted next time you click a Magnet to set an association with Deluge. (e.g. `/usr/bin/deluge`)
* **Windows** users should simply re-run the installer and select the magnet association option.
* **OSX** GTK does not support Magnet URIs (see [#2420](/ticket/2420)) but there is a plugin available: http://forum.deluge-torrent.org/viewtopic.php?f=9&t=52619
* **OSX** GTK does not support Magnet URIs (see [#2420](https://dev.deluge-torrent.org/ticket/2420)) but there is a plugin available: http://forum.deluge-torrent.org/viewtopic.php?f=9&t=52619
### Where does Deluge store its settings/config?
@ -68,7 +68,7 @@ Within the Deluge config in a directory named `state`.
### How do I reset the settings back to default?
If you don't care about losing your current torrents then delete everything in Deluge's [config](/faq#where-does-deluge-store-its-settingsconfig) directory.
If you don't care about losing your current torrents then delete everything in Deluge's [config](/faq.md#where-does-deluge-store-its-settingsconfig) directory.
If you do want to keep your current torrents then delete everything except for the `state` folder.
@ -116,7 +116,7 @@ In the Web UI:
#### How can I reset forgotten password?
1. Stop the Web UI before modifying the `web.conf` file.
2. Edit `web.conf` in [config](/faq#where-does-deluge-store-its-settingsconfig) and delete the entire `pwd_sha1` line or use quick method via command-line e.g.:
2. Edit `web.conf` in [config](/faq.md#where-does-deluge-store-its-settingsconfig) and delete the entire `pwd_sha1` line or use quick method via command-line e.g.:
```
sed -i.bak "/pwd_sha1/d" ~/.config/deluge/web.conf
@ -126,12 +126,12 @@ sed -i.bak "/pwd_sha1/d" ~/.config/deluge/web.conf
#### How do I configure plugins with the Web UI?
Not all plugins are configurable directly with the Web UI, see [Plugins] table for those with Web UI code.
The easiest way to configure plugins is using the GTK UI. If unable to use GTK UI on the machine with your daemon, it is possible to connect to that daemon from another computer with the GTK UI. See [ThinClient](/userguide/thinclient) for more information on remote GTK UI setup.
The easiest way to configure plugins is using the GTK UI. If unable to use GTK UI on the machine with your daemon, it is possible to connect to that daemon from another computer with the GTK UI. See [ThinClient](/userguide/thinclient.md) for more information on remote GTK UI setup.
#### How do I auto-connect to a specific daemon?
1. Stop the Web UI before modifying the `web.conf` file.
2. Edit `web.conf` in [config](/faq#where-does-deluge-store-its-settingsconfig), find `"default_daemon"` and set its value to the daemon `id` in `hostlist.conf`
2. Edit `web.conf` in [config](/faq.md#where-does-deluge-store-its-settingsconfig), find `"default_daemon"` and set its value to the daemon `id` in `hostlist.conf`
e.g. To connect to localhost you would open `hostlist.conf` as see a snippet such as:
@ -152,7 +152,7 @@ The easiest way to configure plugins is using the GTK UI. If unable to use GTK U
#### How do I enable HTTPS?
1. Create a (self-signed) SSL certificate: http://httpd.apache.org/docs/2.0/ssl/ssl_faq.html#selfcert
2. Put the resulting `deluge.crt` and `deluge.key` in the [config's](/faq#where-does-deluge-store-its-settingsconfig) `ssl` directory.
2. Put the resulting `deluge.crt` and `deluge.key` in the [config's](/faq.md#where-does-deluge-store-its-settingsconfig) `ssl` directory.
3. Enable HTTPS in Web UI config and modify the filepaths to match the above files.
4. Restart the Web UI.
@ -201,7 +201,7 @@ $ deluge-console
#### I encountered `BadLoginError("Password does not match")` with localhost daemon?
This is likely due to mismatching config locations, ensure you are running deluge-console with same user as deluged: [More Details](/userguide/thinclient#accessingdelugedservicewithlocaluiclient)
This is likely due to mismatching config locations, ensure you are running deluge-console with same user as deluged: [More Details](/userguide/thinclient.md#accessing-deluged-service-with-local-ui-client)
### Daemon
@ -224,7 +224,7 @@ pkill deluged
#### How do I start the daemon with logging enabled?
See: [Troubleshooting - Enable Logging](/troubleshooting#enable-deluge-logging)
See: [Troubleshooting - Enable Logging](/troubleshooting.md#enable-deluge-logging)
Using the `--do-not-daemonize` (`-d`) option you can also log to console:
@ -234,10 +234,10 @@ deluged -d [-L <loglevel>] [-l <logfile>]
#### I can't connect to the daemon from another machine
See [ThinClient](/userguide/thinclient) for more information but the summary steps are:
See [ThinClient](/userguide/thinclient.md) for more information but the summary steps are:
1. Configure the daemon to allow remote connections
2. Configure [Authentication](/userguide/authentication)
2. Configure [Authentication](/userguide/authentication.md)
3. Restart the daemon.
#### How do I make Deluge connect to a different daemon?
@ -251,7 +251,7 @@ To disable classic mode:
3. Restart Deluge and it will now start in thin-client mode
4. Use the Connection Manager to enter the other daemon details
5.
See [ThinClient](/userguide/thinclient) for more information on remote GTK UI
See [ThinClient](/userguide/thinclient.md) for more information on remote GTK UI
#### How do I stop Deluge from killing the daemon when I quit the GTK UI?
@ -301,11 +301,11 @@ If you're using pre-SP2 Windows Vista*:
|-----------------------------|-|
|Maximum Half-Open Connections|4|
You can then tweak those settings to suit your connection. See [Bandwidth Tweaking](/userguide/bandwidthtweaking).
You can then tweak those settings to suit your connection. See [Bandwidth Tweaking](/userguide/bandwidthtweaking.md).
Note: if you do not know your upload speed, go to http://speedtest.net and run a test. You can view the results in KB/s by choosing "kilobytes" for "Speed Measurement" which can be accessed under "Settings" in the top left corner of the page.
* If you have Deluge setup as a [ThinClient](/userguide/thinclient) then this setting is determined by the OS the daemon is running on, not the thin client.
* If you have Deluge setup as a [ThinClient](/userguide/thinclient.md) then this setting is determined by the OS the daemon is running on, not the thin client.
### Deluge sometimes creates files that I didn't ask it to download?
@ -320,7 +320,7 @@ Force recheck discards all incomplete pieces.
### Does Deluge support Initial or Super Seed?
Not yet, but it will be added in a future release, see [#1903](/ticket/1903).
Not yet, but it will be added in a future release, see [#1903](https://dev.deluge-torrent.org/ticket/1903).
### Does Deluge have an embedded tracker?
@ -382,7 +382,7 @@ Masks: Normal Service `0x00`, Minimize Cost `0x02`, Maximize Reliability `0x04`,
### Can Deluge use blocklists such as SafePeer or PeerGuardian?
You can use the [Blocklist Plugin](/plugins/blocklist).
You can use the [Blocklist Plugin](/plugins/blocklist.md).
### I have a status bar warning: "No Incoming Connections!"
@ -392,4 +392,4 @@ Enabling `UPnP` in Deluge and on your router can automatically open the ports as
## Enable Deluge Logging
[Troubleshooting#enable-deluge-logging](/troubleshooting#enable-deluge-logging)
[troubleshooting.md#enable-deluge-logging](/troubleshooting.md#enable-deluge-logging)

0
docs/installing/linux/debian.md
View File

2
docs/installing/linux/debian/jessie.md
View File

@ -49,7 +49,7 @@ To upgrade libtorrent:
apt-get install -t trusty libtorrent-rasterbar8 python-libtorrent
```
For config and systemd service setup see [systemd](/userguide/initscript/systemd) and [thinclient](userguide/thinclient) guides.
For config and systemd service setup see [systemd](/userguide/initscript/systemd.md) and [thinclient](/userguide/thinclient.md) guides.
For `'add-apt-repository: command not found:` install `software-properties-common`.

2
docs/installing/linux/debian/squeeze.md
View File

@ -48,7 +48,7 @@ aptitude -t unstable install deluge
## Deluge Launchpad PPA
The alternative to using Debian unstable involves using the Deluge Launchpad PPA for Ubuntu Maverick as the release is old enough to not get any unmet dependencies when installed on Squeeze.
*This method does not work for Lenny as it depends on a package that doesn't exist, see [Installing Lenny](/installing/linux/debian/lenny)*
*This method does not work for Lenny as it depends on a package that doesn't exist, see [Installing Lenny](/installing/linux/debian/lenny.md)*
Add PPA to your `/etc/apt/sources.list`:

2
docs/installing/linux.md → docs/installing/linux/index.md
View File

@ -1,6 +1,6 @@
# Installing Deluge On Linux
To install Deluge on Linux, head to the [downloads page](/download) and select the distribution you use.
To install Deluge on Linux, head to the [downloads page](/download.md) and select the distribution you use.
If you are using a 32 bit computer and operating system, you will need to select the package for i386 systems.

2
docs/installing/linux/ubuntu.md
View File

@ -19,7 +19,7 @@
sudo apt-get install deluged deluge-web deluge-console
```
Although Deluge is included in the official [Ubuntu repositories](http://packages.ubuntu.com/search?keywords=deluge-torrent) it may be out of date. To ensure you are using the latest version use the [PPA Repository](/installing/linux/ubuntu#adddelugepparepository), see the steps below.
Although Deluge is included in the official [Ubuntu repositories](http://packages.ubuntu.com/search?keywords=deluge-torrent) it may be out of date. To ensure you are using the latest version use the [PPA Repository](/installing/linux/ubuntu.md#deluge-ppa-repository), see the steps below.
### Deluge PPA Repository
The [Deluge PPA](https://launchpad.net/~deluge-team/+archive/stable) contains the latest Deluge releases for Ubuntu.

6
docs/installing/source.md
View File

@ -34,10 +34,10 @@ pip install twisted[tls] chardet mako pyxdg pillow slimit pypiwin32 pygame certi
## libtorrent (rasterbar)
For those advanced cases where you need to build and install [libtorrent](http://libtorrent.org/) from source, follow this guide: [Building/libtorrent](/building/libtorrent)
For those advanced cases where you need to build and install [libtorrent](http://libtorrent.org/) from source, follow this guide: [Building/libtorrent]/development/building/libtorrent.md)
# Download Source
You can either get the source from a tarball on our [ftp](http://download.deluge-torrent.org/source/?C=M;O=D) or from our [GitRepo](/gitrepo).
You can either get the source from a tarball on our [ftp](http://download.deluge-torrent.org/source/?C=M;O=D) or from our [GitRepo]/development/git/gitrepo.md).
# Building and Installing
Extract the source tarball and in the extracted folder run the build command:
@ -54,7 +54,7 @@ sudo python setup.py install
* *Debian & Ubuntu: Append `--install-layout=deb` to use `/usr/bin/` prefix instead of Debian default `/usr/bin/local/`.*
* *Microsoft Windows: Omit `sudo` prefix.*
For Linux Desktop systems an extra step is required due to an installer [bug](http://dev.deluge-torrent.org/ticket/1389) not copying data files, such as `deluge.desktop`:
For Linux Desktop systems an extra step is required due to an installer [bug](http://dev.deluge-torrent.orghttps://dev.deluge-torrent.org/ticket/1389) not copying data files, such as `deluge.desktop`:
```
sudo python setup.py install_data

2
docs/installing/windows.md
View File

@ -6,4 +6,4 @@ Download the latest installer from: [http://download.deluge-torrent.org/windows]
On Windows the installer installs a standalone application by default into `Program Files` and the bundle includes Python, GTK and all relevant dependencies. The only external requirement that may be not be installed on your system is the [Visual C++ 2008 SP1 Redistributable Package (x86)](http://www.microsoft.com/downloads/details.aspx?familyid=A5C84275-3B97-4AB7-A40D-3802B2AF5FC2&displaylang=en).
For the Deluge config location see: [Faq#where-does-deluge-store-its-settingsconfig](/faq#where-does-deluge-store-its-settingsconfig)
For the Deluge config location see [FAQ](/faq.md#where-does-deluge-store-its-settingsconfig)

52
docs/plan/libtorrent.md
View File

@ -4,45 +4,45 @@ This is page is to collate the work that is required to bring the next Deluge ve
## Tickets requests for new/missing libtorrent features
### Handle/Status
* [ticket:1903 [#1903](/ticket/1903) super_seeding (handle/status)]
* [ticket:607 [#607](/ticket/607) completed_time (handle)]
* [ticket:1294 [#1294](/ticket/1294) seed_mode (add_torrent) flag_seed_mode (status)]
* [ticket:1165 [#1165](/ticket/1165) add_url_seed, remove_url_seed (handle)]
* [ticket:1206 [#1206](/ticket/1206) set_upload_mode (handle) upload_mode (status) flag_upload_mode (add_torrent)]
* [ticket:2347 [#2347](/ticket/2347) orig_files (status)]
* [ticket:1903 [#1903](https://dev.deluge-torrent.org/ticket/1903) super_seeding (handle/status)]
* [ticket:607 [#607](https://dev.deluge-torrent.org/ticket/607) completed_time (handle)]
* [ticket:1294 [#1294](https://dev.deluge-torrent.org/ticket/1294) seed_mode (add_torrent) flag_seed_mode (status)]
* [ticket:1165 [#1165](https://dev.deluge-torrent.org/ticket/1165) add_url_seed, remove_url_seed (handle)]
* [ticket:1206 [#1206](https://dev.deluge-torrent.org/ticket/1206) set_upload_mode (handle) upload_mode (status) flag_upload_mode (add_torrent)]
* [ticket:2347 [#2347](https://dev.deluge-torrent.org/ticket/2347) orig_files (status)]
### Session
* ~~Use `flush_disk_cache` flag with `save_resume_data` when stopping session~~
* [ticket:2122 [#2122](/ticket/2122) listen_on_flags: listen_reuse_address and listen_no_system_port]
* [ticket:2133 [#2133](/ticket/2133) listen_on: Change incoming port randomization]
* [ticket:2219 [#2219](/ticket/2219) set_i2p_proxy() i2p_proxy()]
* ~~[ticket:1337 [#1337](/ticket/1337) make_magnet_uri()]~~
* [ticket:2122 [#2122](https://dev.deluge-torrent.org/ticket/2122) listen_on_flags: listen_reuse_address and listen_no_system_port]
* [ticket:2133 [#2133](https://dev.deluge-torrent.org/ticket/2133) listen_on: Change incoming port randomization]
* [ticket:2219 [#2219](https://dev.deluge-torrent.org/ticket/2219) set_i2p_proxy() i2p_proxy()]
* ~~[ticket:1337 [#1337](https://dev.deluge-torrent.org/ticket/1337) make_magnet_uri()]~~
### Session_settings
These should be covered by the WiP by gazpachoking to query lt for all available settings.
* [ticket:2115 [#2115](/ticket/2115) uTP/TCP Enable/Disable]
* [ticket:1466 [#1466](/ticket/1466) send_buffer_watermark, send_buffer_watermark_factor]
* [ticket:1903 [#1903](/ticket/1903) strict_super_seeding]
* [ticket:1384 [#1384](/ticket/1384) announce_ip]
* [ticket:2257 [#2257](/ticket/2257) active_dht_limit, active_tracker_limit and active_lsd_limit]
* [ticket:2059 [#2059](/ticket/2059) tracker_backoff]
* [ticket:1677 [#1677](/ticket/1677) apply_ip_filter_to_trackers (for blocklist)]
* [ticket:1395 [#1395](/ticket/1395) announce_to_all_tiers]
* [ticket:2472 [#2472](/ticket/2472) anonymous mode]
* [ticket:2115 [#2115](https://dev.deluge-torrent.org/ticket/2115) uTP/TCP Enable/Disable]
* [ticket:1466 [#1466](https://dev.deluge-torrent.org/ticket/1466) send_buffer_watermark, send_buffer_watermark_factor]
* [ticket:1903 [#1903](https://dev.deluge-torrent.org/ticket/1903) strict_super_seeding]
* [ticket:1384 [#1384](https://dev.deluge-torrent.org/ticket/1384) announce_ip]
* [ticket:2257 [#2257](https://dev.deluge-torrent.org/ticket/2257) active_dht_limit, active_tracker_limit and active_lsd_limit]
* [ticket:2059 [#2059](https://dev.deluge-torrent.org/ticket/2059) tracker_backoff]
* [ticket:1677 [#1677](https://dev.deluge-torrent.org/ticket/1677) apply_ip_filter_to_trackers (for blocklist)]
* [ticket:1395 [#1395](https://dev.deluge-torrent.org/ticket/1395) announce_to_all_tiers]
* [ticket:2472 [#2472](https://dev.deluge-torrent.org/ticket/2472) anonymous mode]
### Alerts
* [ticket:1466 [#1466](/ticket/1466) performance alert: send_buffer_watermark_too_low]
* [ticket:637 [#637](/ticket/637) storage_moved_alert]
* [ticket:2006 [#2006](/ticket/2006) storage_moved_failed_alert]
* [ticket:2490 [#2490](/ticket/2490) Support for external_ip_alert]
* [ticket:1466 [#1466](https://dev.deluge-torrent.org/ticket/1466) performance alert: send_buffer_watermark_too_low]
* [ticket:637 [#637](https://dev.deluge-torrent.org/ticket/637) storage_moved_alert]
* [ticket:2006 [#2006](https://dev.deluge-torrent.org/ticket/2006) storage_moved_failed_alert]
* [ticket:2490 [#2490](https://dev.deluge-torrent.org/ticket/2490) Support for external_ip_alert]
# Features for future Deluge releases
* Support SSL Torrents (also see [#2195](/ticket/2195))
* [ticket:2196 [#2196](/ticket/2196) piece_deadline (handle)]
* Support SSL Torrents (also see [#2195](https://dev.deluge-torrent.org/ticket/2195))
* [ticket:2196 [#2196](https://dev.deluge-torrent.org/ticket/2196) piece_deadline (handle)]
* ~~Torrent priority with set_priority (handle) priority (status)~~
* [ticket:367 [#367](/ticket/367) Do not store per-torrent settings that are saved in the resume data]
* [ticket:367 [#367](https://dev.deluge-torrent.org/ticket/367) Do not store per-torrent settings that are saved in the resume data]
* ~~Replace add_torrent with the more efficient non-blocking async_add_torrent.~~
Notable libtorrent 1.0 [Changelog](http://sourceforge.net/p/libtorrent/code/HEAD/tree/branches/RC_1_0/ChangeLog) entries:

2
docs/plan/python3.md
View File

@ -1,6 +1,6 @@
# Python 3 Port
This page provides more detailed information on porting to Python 3 started in ticket [#1328](/ticket/1328).
This page provides more detailed information on porting to Python 3 started in ticket [#1328](https://dev.deluge-torrent.org/ticket/1328).
The current consensus is that the core and common files should be prepared for a future Twisted release with full Python 3 support and UI's worked on at a later date.

2
docs/plugins/autopriority.md
View File

@ -3,7 +3,7 @@
This plugin has the same functionality as the obsolete sequential download script.
## Download
[AutoPriority-0.5.1-py2.6](/plugins autopriority/autopriority-0.5.1/py2.6.egg)
## Features

2
docs/plugins/flexrss.md
View File

@ -2,7 +2,7 @@
This plugin is only compatible with the **0.5.x** and **1.1.x** releases of deluge.
Note: For **1.2.x** or newer releases see [FlexGet](/plugins/flexget) or [yarss2](plugins/yarss2).
Note: For **1.2.x** or newer releases see [FlexGet](/plugins/flexget.md) or [yarss2](/plugins/yarss2.md).
## Overview

10
docs/plugins/ifacewatch.md
View File

@ -1,4 +1,4 @@
# [IfaceWatch](/ifacewatch)
# IfaceWatch
Watch for IP changes on specific interfaces and notify libtorrent.
@ -18,7 +18,7 @@ Watch for IP changes on specific interfaces and notify libtorrent.
### Download
Download [IfaceWatch](/ifacewatch) from the [https://github.com/bendikro/deluge-iface-watch/releases](https://github.com/bendikro/deluge-iface/watch/releases).
Download IfaceWatch from the [https://github.com/bendikro/deluge-iface-watch/releases](https://github.com/bendikro/deluge-iface/watch/releases).
You must download the egg that matches your python version (Python 2.6 or 2.7). See [http://dev.deluge-torrent.org/wiki/Plugins#InstallingPlugins](http://dev.deluge-torrent.org/wiki/Plugins#InstallingPlugins) for details if you are unsure.
@ -30,14 +30,14 @@ See [instructions for how to install](http://dev.deluge-torrent.org/wiki/Plugins
If you run Deluge in non-Classic mode (daemon and client setup), take a look at [Running a server/seedbox with a Deluge daemon](http://dev.deluge-torrent.org/wiki/Plugins#Client-ServerSetups)
### Configuring [IfaceWatch](/ifacewatch)
### Configuring IfaceWatch
When enabling the plugin in Deluge a new tab is created in the Deluge prefences for [IfaceWatch](/ifacewatch).
When enabling the plugin in Deluge a new tab is created in the Deluge prefences for IfaceWatch.
The settings allows specifying a network interface, such as **eth0**, to be
monitored for changes at the interval specified in the setting.
In a VPN scenario where you want only the torrent traffic to pass through the VPN interface
it is necessary to manually set up routing table rules for this traffic. When the IP changes for
an interface, [IfaceWatch](/ifacewatch) will only instruct Deluge to change the IP that libtorrent listens on.
an interface, IfaceWatch will only instruct Deluge to change the IP that libtorrent listens on.
Therefore it is necessary to adjust the routing table rules as well when the IP changes.

42
docs/plugins/index.md
View File

@ -6,16 +6,16 @@
| **Name** | **Description** | **WebUI** |
| ------------------------------- | ------------------------------------------------------------------- | -------------------- |
| [AutoAdd](/plugins/autoadd) | Multiple watch folder support | _Yes_ |
| [Blocklist](/plugins/blocklist) | Download and import IP blocklists | _Yes_ |
| [Execute](/plugins/execute) | Executes a command upon an event | _Yes_ |
| [AutoAdd](/plugins/autoadd.md) | Multiple watch folder support | _Yes_ |
| [Blocklist](/plugins/blocklist.md) | Download and import IP blocklists | _Yes_ |
| [Execute](/plugins/execute.md) | Executes a command upon an event | _Yes_ |
| Extractor | Extracts files upon completion | _Yes_ |
| Label | Assign labels to torrents for custom actions | _Yes_ |
| Notification | Provides Email, Popup, Blink and Sound notifications | _Yes_ |
| Scheduler | Limit Deluge bandwidth depending on schedule | _Yes_ |
| [Stats](/plugins/stats) | Displays pretty graphs of statistics | _No_ |
| [Stats](/plugins/stats.md) | Displays pretty graphs of statistics | _No_ |
| WebUI | Start the web interface from within Deluge | _Infinite recursion_ |
| [Toggle](/plugins/toggle) | Allows the users to set the session to either "paused" or "resumed" | _No_ |
| [Toggle](/plugins/toggle.md) | Allows the users to set the session to either "paused" or "resumed" | _No_ |
---
@ -23,7 +23,7 @@
| **Name** | **Description** | **WebUI** | **Deluge 2.x support** |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | --------- | ---------------------- |
| [AutoPriority](/plugins/autopriority) | Downloads torrents in alphabetical order | _No_ | _No_ |
| [AutoPriority](/plugins/autopriority.md) | Downloads torrents in alphabetical order | _No_ | _No_ |
| [AutoShutdown](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=41165) | Shutdown or hibernate computer when all torrents complete downloading | _No_ | _No_ |
| [Auto Remove](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=36443) | Limit the number of inactive torrents that are kept | _No_ | _No_ |
| [Auto Remove Plus](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=47243) | Based on Auto Remove but with more features | **Yes** | **Yes** |
@ -32,15 +32,15 @@
| [CopyMagnetURI](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=47501) | Copy the magnet URI of the selected torrent(s) to the clipboard | _No_ | _No_ |
| [Default Trackers](https://github.com/stefantalpalaru/deluge-default-trackers) | Add default trackers for all your new torrents | _No_ | **Yes** |
| [FileBotTool](https://github.com/Laharah/deluge-FileBotTool) | Integrates automatic media sorting using [FileBot](http://www.filebot.net/) | _No_ | **Yes** |
| [IfaceWatch](/plugins/ifacewatch) | Watch for IP changes on specific interfaces and notify libtorrent | _No_ | **Yes** |
| [IfaceWatch](/plugins/ifacewatch.md) | Watch for IP changes on specific interfaces and notify libtorrent | _No_ | **Yes** |
| [IPstatusbar](https://github.com/cas--/deluge-ipstatusbar/releases) | Show the external IP address being listened on in the status bar | _No_ | _No_ |
| [LabelPlus](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=42629) | Labeling plugin with additional features | _No_ | **Yes** |
| [ltConfig](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=42887) | Configure libtorrent settings | **Yes** | **Yes** |
| [MyScheduler](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=54025) | Scheduler with Force Start | **Yes** | _No_ |
| [NetWatcher](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=40769) | Monitors the local network activity and deciding if pause or resume all torrents. | _No_ | _No_ |
| [NetWatcher2](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=47327) | Monitors the local network activity and automatically limits the download speed. | _No_ | _No_ |
| [Pieces](/plugins/pieces) | View status and set priority of each individual piece of a torrent | **Yes** | _No_ |
| [PreventSuspend](/plugins/preventsuspend) | Prevents computer suspending | _No_ | _No_ |
| [Pieces](/plugins/pieces.md) | View status and set priority of each individual piece of a torrent | **Yes** | _No_ |
| [PreventSuspend](/plugins/preventsuspend.md) | Prevents computer suspending | _No_ | _No_ |
| [PreventSuspendPlus](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=52115) | Prevents computer suspending (inc Windows support) | **Yes** | _No_ |
| [Ratio](https://forum.deluge-torrent.org/viewtopic.php?f=9&t=54864) | Show total downloads, uploads, and overall share ratio in status bar. | _No_ | _No_ |
| [Randomize](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=38747) | Randomizes incoming port based on configurable interval and blocked port check | _No_ | _No_ |
@ -55,15 +55,15 @@
| [Updatorr](http://pypi.python.org/pypi/Updatorr/) | Automatic torrents updates for forum-like trackers | _No_ | _No_ |
| [uTorrentImport](https://github.com/Laharah/deluge-uTorrentImport) | a cross platform Deluge plugin to import torrents from uTorrent | _No_ | _No_ |
| [WebAPI](https://pypi.python.org/pypi/deluge-webapi) | Alternative JSON API for WebUI | **Yes** | **Yes** |
| [YaRSS2](/plugins/yarss2) | An RSS plugin configurable through the GUI | _No_ | **Yes** |
| [YaRSS2](/plugins/yarss2.md) | An RSS plugin configurable through the GUI | _No_ | **Yes** |
### Unmaintained Plugins
| **Name** | **Description** | **WebUI** | **Deluge 2.x support** |
| ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | --------- | ---------------------- |
| [XMPP Notify](/plugins/xmppnotify) | XMPP notify/control bot | _No_ | _No_ |
| [XMPP Notify](/plugins/xmppnotify.md) | XMPP notify/control bot | _No_ | _No_ |
| [YaRSS](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=31553) | Simple RSS plugin for TV Shows | _No_ | _No_ |
| [Batch Renamer](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=35615) | Rename multiple files in torrents for tidiness | _No_ | _No_ |
| [Categorise](/plugins/categorise) | Moves downloaded torrent to a specific directory depending on type | _No_ | _No_ |
| [Categorise](/plugins/categorise.md) | Moves downloaded torrent to a specific directory depending on type | _No_ | _No_ |
| [Copy Completed](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=33995) | Copies completed torrents to another location | **Yes** | _Unknown_ |
| [CopyLimit](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=39173) | Controls upload "ratio" while downloading based on torrent total size | _No_ | _Unknown_ |
| [Delete Partials](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=28915) | Deletes partial files left by 'Do not download' | _No_ | _No_ |
@ -97,13 +97,13 @@ _Extensions or scripts for applications that enable interaction with Deluge_
| [RCDefaultApp](http://www.rubicode.com/Software/RCDefaultApp/) | General preference pane to configure default apps, used to link magnet links to Deluge-Magnet-Handler on newer macs |
| [ConkyDeluge](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=30825) | Script to display Deluge statistics within Conky |
| [Docky Helper](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=30985) | Docky helper that shows transfer rates on the Deluge badge |
| [FlexGet Plugin](http://flexget.com/wiki/Plugins/deluge) | Deluge Plugin for the advanced RSS tool [(More Info)](/plugins/flexget) |
| [FileBot Script](http://forum.deluge-torrent.org/viewtopic.php?f=9&p=172841#p172841) | Uses [Execute](/plugins/execute) plugin to run [filebot](http://filebot.sourceforge.net/) which renames, categorizes, and finds subtitles and artwork |
| [FlexGet Plugin](http://flexget.com/wiki/Plugins/deluge) | Deluge Plugin for the advanced RSS tool [(More Info)](/plugins/flexget.md) |
| [FileBot Script](http://forum.deluge-torrent.org/viewtopic.php?f=9&p=172841#p172841) | Uses [Execute](/plugins/execute.md) plugin to run [filebot](http://filebot.sourceforge.net/) which renames, categorizes, and finds subtitles and artwork |
| [Inoreader](https://github.com/maziara/deluge-feed-inoreader) | Tag the articles in Inoreader and they will be downloaded in Deluge |
| [Periscope Subtitle Script](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=38957&p=163277) | Uses [Execute](/plugins/execute) plugin to run a subtitle searching script based around [periscope](https://code.google.com/p/periscope/) module |
| [Periscope Subtitle Script](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=38957&p=163277) | Uses [Execute](/plugins/execute.md) plugin to run a subtitle searching script based around [periscope](https://code.google.com/p/periscope/) module |
| [Transdroid](http://www.transdroid.org/download/using-deluge-on-ubuntu/) | Manage your torrents from your Android device |
| [XBMC Plugin](http://code.google.com/p/deluge-xbmc-plugin/) | Connects via WebUI to display and manipulate the status of torrents within XBMC |
| [Plex Script](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=46529) | Uses [Execute](/plugins/execute) plugin for managing an automated [plex media server](https://plex.tv/) setup. |
| [Plex Script](http://forum.deluge-torrent.org/viewtopic.php?f=9&t=46529) | Uses [Execute](/plugins/execute.md) plugin for managing an automated [plex media server](https://plex.tv/) setup. |
---
@ -113,7 +113,7 @@ _Extensions or scripts for applications that enable interaction with Deluge_
Plugin eggs have the _Python_ version encoded in the filename and will only load in Deluge if the Python versions match.
- Verify Deluge [Python version](/troubleshooting#python-version).
- Verify Deluge [Python version](/troubleshooting.md#python-version).
### Download
@ -131,7 +131,7 @@ GUI::
`Preferences -> Plugins` click `Install plugin`, locate the downloaded plugin `egg` and select it to install.
Manually::
Copy the plugin `egg` to the Deluge [config](/faq#where-does-deluge-store-its-settingsconfig) `plugins` directory:
Copy the plugin `egg` to the Deluge [config](/faq.md#where-does-deluge-store-its-settingsconfig) `plugins` directory:
If the Plugin does not show up in the Plugins list then it is likely the incorrect Python version of the plugin has been installed, also see below.
@ -144,9 +144,9 @@ For example in the setup below you will have to install the py2.6 egg on the loc
- Local machine with Python 2.6 running `GTKUI` client.
- Remote server with Python 2.7 running `deluged`.
See [Determine Python Version](/plugins#determine-python-version) above.
See [Determine Python Version](/plugins/index.md#determine-python-version) above.
## Plugin Development
- [Plugin Development](/development/plugins)
- [PluginIdeas](/development/pluginideas)
- [Plugin Development](/development/plugins/index.md)
- [PluginIdeas](/development/plugins/pluginideas.md)

6
docs/plugins/pieces.md
View File

@ -20,13 +20,15 @@ Version 0.2 adds a tooltip to show which piece the mouse is hovering over, and a
View of the tab:
* Todo: Add screenshot of piece tab
Piece # tooltip (shows piece priority in parens):
![](/tooltip.png)
* Todo: Add screenshot piece info tooltip on hover
Menu to set the priority for a piece:
![](set_priority.png)
* Todo: Add screenshot piece priority popup menu
## Discussion/Support
Please use the forum post: http://forum.deluge-torrent.org/viewtopic.php?f=9&t=27545

2
docs/plugins/remotenotify.md
View File

@ -50,7 +50,7 @@ cp dist/RemoteNotify-0.1-py2.5.egg ~/.config/deluge/plugins/
### Start & Configure the Plugin
1. Start deluged & deluge webUI
2. Enable [RemoteNotify](/remotenotify) plugin ( using webui at http://yourdelugedomain/config/plugins </ the ajax theme doesn't have this )
2. Enable RemoteNotify plugin ( using webui at http://yourdelugedomain/config/plugins </ the ajax theme doesn't have this )
3. Enter The Account & Password for your Bots jabber and Email account & save. ( http://yourdelugedomain/config/remotenotify )
4. Enter Notifier Email SMTP server. (For gmail use *smtp.gmail.com* )
5. Restart deluged. ( Sadly, this is necessary because of a weird Twisted Words bug )

14
docs/troubleshooting.md
View File

@ -17,23 +17,17 @@ Common startup errors with solutions:
* Windows OS: `Deluge not starting` or `Error:14001 side-by-side configuration`
* Install *vcredist_x86.exe*: [Visual C++ 2008 SP1 Redistributable Package](https://www.microsoft.com/en-us/download/details.aspx?id=26368)
**For any other issues not solved here see** [Bug Reporting](/contributing/bugreporting) **and follow the detailed steps.**
**For any other issues not solved here see** [Bug Reporting](/contributing/bugreporting.md) **and follow the detailed steps.**
## Deluge's GTK UI won't connect to a remote daemon
Make sure both the GTK UI and the daemon are the same (or similar, e.g. 1.3.x) versions.
Otherwise make sure you've followed the [thin client userguide](/userguide/thinclient).
Otherwise make sure you've followed the [thin client userguide](/userguide/thinclient.md).
## Deluge isn't working! What should I do?
See [Bug Reporting](/contributing/bugreporting)
<!--
This is currently not the case.
~~If you are on Windows, the debug logs are located in your [wiki:Faq#WheredoesDelugestoreitssettings settings folder] under the names `deluged.log` and `deluge.log`.~~
--->
See [Bug Reporting](/contributing/bugreporting.md)
If you are pasting the log on the forums, please use the `[code][/code]` tags.
@ -85,7 +79,7 @@ There is a bug in the way GTK sets language on Windows but there are several wor
## libtorrent version
The libtorrent version is in the output of [Deluge Version](/troubleshooting#delugeversion).
The libtorrent version is in the output of [Deluge Version](/troubleshooting.md#deluge-version).
From the terminal::
`python -c "from deluge._libtorrent import lt; print lt.version"`

2
docs/userguide/authentication.md
View File

@ -1,5 +1,5 @@
## Authentication
The daemon looks at the file [<config folder>](http://dev.deluge-torrent.org/wiki/Faq#where-does-deluge-store-its-settingsconfig)/auth for doing authentication.
The daemon looks at the file [<config folder>](/faq.md#where-does-deluge-store-its-settingsconfig)/auth for doing authentication.
The format of this file is straightforward, each line contains a username:password:level tuple in plaintext.

14
docs/userguide/index.md
View File

@ -4,29 +4,29 @@
Guides for installing Deluge:
* [From source-code](/installing/source)
* [From source-code](/installing/source.md)
Installation on a server (to run Deluge daemon in the background) setting up a `service` is useful:
* [Service](/userguide/service)
* [Service](/userguide/service.md)
To allow clients to remotely connect to the daemon `deluged` follow this guide:
* [ThinClient](/userguide/thinclient)
* [ThinClient](/userguide/thinclient.md)
## Advanced Usage
* [Reverse Proxy (Web UI)](/userguide/webui/reverseproxy)
* [Reverse Proxy (Web UI)](/userguide/webui/reverseproxy.md)
## Questions or Issues
* **[FAQ](/faq)**
* **[FAQ](/faq.md)**
* **[Troubleshooting](/troubleshooting)**
* **[Troubleshooting](/troubleshooting.md)**
* **[Report a Bug](/contributing/bugreporting)**
* **[Report a Bug](/contributing/bugreporting.md)**
### Contact Us

2
docs/userguide/initscript.md
View File

@ -1 +1 @@
See [UserGuide Service](/userguide/service).
See [UserGuide Service](/userguide/service.md).

2
docs/userguide/initscript/fedora.md
View File

@ -1,4 +1,4 @@
**For Fedora version > 15 use: [systemd](/userguide/service/systemd)**
**For Fedora version > 15 use: [systemd](/userguide/service/systemd.md)**
# Fedora Init Script

2
docs/userguide/initscript/freebsd.md
View File

@ -1 +1 @@
See [UserGuide/Service/FreeBSD](/userguide/service/freebsd).
See [UserGuide/Service/FreeBSD](/userguide/service/freebsd.md).

2
docs/userguide/initscript/systemd.md
View File

@ -1 +1 @@
See [UserGuide/Service/systemd](/userguide/service/systemd).
See [UserGuide/Service/systemd](/userguide/service/systemd.md).

2
docs/userguide/initscript/ubuntu.md
View File

@ -1 +1 @@
See [UserGuide/Service/DebianUbuntuInitd](/userguide/service/debianubuntuinitd).
See [UserGuide/Service/DebianUbuntuInitd](/userguide/service/debianubuntuinitd.md).

12
docs/userguide/service.md
View File

@ -10,20 +10,20 @@ The Deluge daemon `deluged` and Web UI `deluge-web` can both be run as services.
Most Linux distributions now use systemd. See [wikipedia](https://en.wikipedia.org/wiki/Systemd#Adoption_and_reception) for releases with systemd as *default*.
* [systemd](/userguide/service/systemd)
* [systemd](/userguide/service/systemd.md)
* [Upstart](/userguide/service/upstart) *(ubuntu 11.04 to 14.10)*
* [Upstart](/userguide/service/upstart.md) *(ubuntu 11.04 to 14.10)*
* [init.d](/userguide/service/debianubuntuinitd) *(obsolete)*
* [init.d](/userguide/service/debianubuntuinitd.md) *(obsolete)*
## Microsoft Windows
* [Windows service](/userguide/service/ms_windows)
* [Windows service](/userguide/service/ms_windows.md)
## Apple OS X
* [launchd](/userguide/service/launchd)
* [launchd](/userguide/service/launchd.md)
## FreeBSD
* [rc.d](/userguide/service/freebsd)
* [rc.d](/userguide/service/freebsd.md)

4
docs/userguide/service/debianubuntuinitd.md
View File

@ -1,7 +1,7 @@
# Ubuntu Init Script
---
**This page is for obsolete/unsupported Ubuntu distributions, see [systemd](/userguide/service/systemd) or [upstart](userguide/service/upstart) depending on your distribution.**
**This page is for obsolete/unsupported Ubuntu distributions, see [systemd](/userguide/service/systemd.md) or [upstart](/userguide/service/upstart.md) depending on your distribution.**
---
@ -231,7 +231,7 @@ DAEMON1_ARGS="-d -L warning -l /var/log/deluge/daemon/warning.log" #
DAEMON2=/usr/bin/deluge-web
DAEMON2_ARGS="-L warning -l /var/log/deluge/web/warning.log"
```
* See [Logging](/faq#enable-deluge-logging) for possible loglevels.
* See [Logging](/faq.md#enable-deluge-logging) for possible loglevels.
Restart the daemon
```

4
docs/userguide/service/upstart.md
View File

@ -1,6 +1,6 @@
# Ubuntu Upstart Job
**This page only applies to Ubuntu 11.04 Natty up to 14.10 Utopic, for newer Ubuntu distributions see: [systemd](/userguide/service/systemd).**
**This page only applies to Ubuntu 11.04 Natty up to 14.10 Utopic, for newer Ubuntu distributions see: [systemd](/userguide/service/systemd.md).**
Firstly ensure Deluge daemon and Web UI are installed:
@ -137,7 +137,7 @@ exec start-stop-daemon -S -c $uid:$gid -k $umask -x /usr/bin/deluged -- -d -l /v
```
exec start-stop-daemon -S -c $uid:$gid -k $umask -x /usr/bin/deluge-web -- -l /var/log/deluge/web.log -L warning
```
* Refer to the [FAQ](/faq#enable-deluge-logging) for possible log-levels.
* Refer to the [FAQ](/faq.md#enable-deluge-logging) for possible log-levels.
Restart the daemon:

16
docs/userguide/thinclient.md
View File

@ -6,11 +6,11 @@ Deluge can be setup in such a way that a Deluge daemon, `deluged`, can be setup
## Deluge Daemon Setup
The Deluge daemon `deluged` and `deluge-console` should be [installed](/installing) on the server.
The Deluge daemon `deluged` and `deluge-console` should be [installed](/installing/index.md) on the server.
See the [service guides](userguide/service) to run `deluged` as a service so that it starts/stops on server boot/shutdown. Substitute any daemon start or stop commands below with the appropriate service commands.
See the [service guides](/userguide/service.md) to run `deluged` as a service so that it starts/stops on server boot/shutdown. Substitute any daemon start or stop commands below with the appropriate service commands.
To debug any problems setting up `deluged` [enable logging](/faq#howdoistartthedaemonwithloggingenabled) and check for errors.
To debug any problems setting up `deluged` [enable logging](/faq.md#how-do-i-start-the-daemon-with-logging-enabled) and check for errors.
### Create Default Config
@ -21,13 +21,13 @@ deluged
killall deluged
```
*Note: The config location is either the [default location](/faq#where-does-deluge-store-its-settingsconfig) with reference to the `user` that `deluged` is running as. Alternatively if using a service it will be specified in the service config files with `-c <path>` option.*
*Note: The config location is either the [default location](/faq.md#where-does-deluge-store-its-settingsconfig) with reference to the `user` that `deluged` is running as. Alternatively if using a service it will be specified in the service config files with `-c <path>` option.*
### Add User to the authentication file
Create a Deluge user for clients/UIs to access the daemon by editing the authentication file, `auth`, located in the above config location.
The `auth` file should consist of lines of `<username>:<password>:<level>`. Replace <username> and <password> with your choice and <level> with the desired [ authentication level](/userguide/authentication).
The `auth` file should consist of lines of `<username>:<password>:<level>`. Replace <username> and <password> with your choice and <level> with the desired [ authentication level](/userguide/authentication.md).
You can use your favourite text editor to achieve this or can be done with a one-line echo command e.g.:
@ -82,7 +82,7 @@ The Deluge GTK UI setup require switching the GTK UI from Classic mode to Thin-c
1. In `Preferences -> Interface` and disable (untick) `Classic Mode`
2. Restart `deluge` and you should see the `Connection Manager`.
* If it is not needed you can remove the `localhost` daemon.
* If SSH Tunnelling, before continuing [Create SSH Tunnel](/userguide/thinclient#createsshtunnel), and for `Hostname`, below, `127.0.0.2` *must* be used.
* If SSH Tunnelling, before continuing [Create SSH Tunnel](#create-ssh-tunnel), and for `Hostname`, below, `127.0.0.2` *must* be used.
3. Create a new entry with `Add` button:
* `Hostname` is your server's IP.
* `Port` should be default `58846`.
@ -128,12 +128,12 @@ deluge-console "connect <host>[:<port>] <user> <password> ; add $(TorrentPathNam
The Web UI is slightly different as the `client` is a web server daemon `deluge-web` that connects to a running `deluged`.
1. [Install ](/installing) `deluge-web` and run it:
1. [Install ](/installing/index.md) `deluge-web` and run it:
```sh
deluge-web
```
Note: To run it in the background as a daemon, use `--fork` option. You may also want to set it up as a [service](/userguide/initscript).
Note: To run it in the background as a daemon, use `--fork` option. You may also want to set it up as a [service](/userguide/initscript.md).
In your web browser, enter the url below where <server> is the IP address of the server:

11
mkdocs.yml
View File

@ -27,8 +27,8 @@ nav:
- Download: download.md
- Support:
- userguide/index.md
- ... | installing/*.md
- ... | userguide/*.md
- ... | installing/**/*.md
- ... | userguide/**/*.md
- FAQ: faq.md
- Troubleshooting: troubleshooting.md
- Contact: contactus.md
@ -41,4 +41,9 @@ nav:
- Pull Requests: contributing/pullrequests.md
- Development:
- Development: development/index.md
- ... | development/*.md
- ... | development/**/*.md
validation:
omitted_files: warn
absolute_links: relative_to_docs
unrecognized_links: warn
anchors: warn