Deluge BitTorrent client - Git mirror, PRs only
https://www.deluge-torrent.org
82ecf8a416
- Change the layout and contents of docs to be better organised and follow ideas from: https://www.divio.com/blog/documentation/ - Use markdown for non-technical documents to speed up writing. - Added new sections and imported documents from Trac wiki. Build fixes: - Added a patch to fix recommonmark 0.4 and doc referencing: https://github.com/rtfd/recommonmark/issues/93 - Set docs build in tox to Py2.7 since there are problems with autodoc mocking multiple inheritance on Python 3 resulting in metaclass errors. - Supressed warning about `modules.rst` not in the toctree by creating a static `modules.rst` with `:orphan:` file directive and add to git. Also skip creating this toc file with sphinx-apidoc in setup and tox. - Simplified finding exported RPC and JSON API methods by adding an autodoc custom class directive. Removed unneeded __rpcapi.py. |
||
---|---|---|
deluge | ||
docs | ||
packaging | ||
.gitattributes | ||
.gitignore | ||
.pre-commit-config.yaml | ||
.prettierignore | ||
.prettierrc.yaml | ||
.pylintrc | ||
.travis.yml | ||
AUTHORS | ||
CHANGELOG.md | ||
DEPENDS.md | ||
LICENSE | ||
MANIFEST.in | ||
README.md | ||
appveyor.yml | ||
gen_web_gettext.py | ||
generate_pot.py | ||
minify_web_js.py | ||
msgfmt.py | ||
pyproject.toml | ||
requirements-dev.txt | ||
requirements-docs.txt | ||
requirements-tests.txt | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
tox.ini | ||
version.py |
README.md
Deluge BitTorrent Client
Deluge is a BitTorrent client that utilizes a daemon/client model. There are various user interfaces available for Deluge such as the GTK-UI, the Web-UI and a Console-UI. Deluge uses libtorrent in it's backend to handle the BitTorrent protocol.
Installation
Instruction for installing from source code. See DEPENDS for build and runtime dependencies. Further details on the wiki: Installing/Source.
python setup.py build
python setup.py install
Usage
There are various user-interfaces and a daemon for Deluge that can be used as follows:
-
Gtk
deluge
ordeluge-gtk
-
Console
deluge-console
-
Web
deluge-web
Go to http://localhost:8112 and use default password
deluge
. -
Daemon
deluged
See Thinclient guide for connecting to the daemon from another machine.