Skip to content

Commit

Permalink
installation chapter done for now
Browse files Browse the repository at this point in the history
  • Loading branch information
pyroscope committed Mar 19, 2017
1 parent 005667f commit 2fdf44c
Show file tree
Hide file tree
Showing 3 changed files with 107 additions and 9 deletions.
6 changes: 6 additions & 0 deletions docs/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{% extends "!layout.html" %}

{% block menu %}
{{ super() }}
<a href="genindex.html">Index</a>
{% endblock %}
108 changes: 100 additions & 8 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,123 @@ Installation Guide

This chapter has some pointers to common ways of installing
*rTorrent* on your machine. It does not provide yet another way to do that,
because there already are plentiful and redundant sources for that out there.
because there already are plentiful and redundant sources out there.


Installation Using OS Packages
------------------------------

**TODO**

* the `rTorrent wiki <https://github.com/rakshasa/rtorrent/wiki#packages>`_ lists package names and installation commands for a lot of *Linux* distributions and other operating systems.
* The `rTorrent wiki <https://github.com/rakshasa/rtorrent/wiki#packages>`_ lists package names and installation commands for a lot of *Linux* distributions and other operating systems.
* DEB packages of *rTorrent-PS* for Debian and Ubuntu are on `Bintray <https://bintray.com/pyroscope/rtorrent-ps/rtorrent-ps/>`_.
* *“Arch User Repository”* (AUR) PKGBUILDs maintained by `@xsmile <https://github.com/xsmile>`_ for
`libtorrent-ps <https://aur.archlinux.org/packages/libtorrent-ps/>`_ and
`rtorrent-ps <https://aur.archlinux.org/packages/rtorrent-ps/>`_.


Automated Installation
----------------------

**TODO**
This is just a selection of the myriads of project out there that perform automated installs.
If you miss something, please make sure a potential new entry is actually still maintained,
and mention what target platforms it is designed and tested for.

Projects that work on *Debian* very likely also work on *Ubuntu*.
Just make sure the release dates match reasonably, i.e. *Jessie* is equivalent to either *Xenial* or *Trusty*.
If you want to run *ruTorrent*, the default version of *PHP* is very important (either 5 or 7).

.. glossary::

`pimp-my-box <https://github.com/pyroscope/pimp-my-box#pimp-my-box>`_

*Ansible · Ubuntu Xenial + Trusty · Debian Jessie + Wheezy · Raspian*

This will install *rTorrent-PS*, *pyrocore*, and related software onto any remote dedicated server or VPS with root access, running *Debian* or a Debian-like OS. It does so via *Ansible*, which is in many ways superior to the usual *“call a bash script to set up things once and never be able to update them again”*, since you can run this setup repeatedly to either fix problems, or to install upgrades and new features added to the project's repository.

`QuickBox <https://github.com/QuickBox>`_

*bash + Javascript*

*QuickBox* provides easy seedbox and services management from a web dashboard.
With the click of a button users can install additional application packages.

`AtoMiC-ToolKit <https://github.com/htpcBeginner/AtoMiC-ToolKit>`_

*bash · Ubuntu/Mint · full HTPC setup*

*AtoMiC Toolkit* simplifies the setup of a HTPC or home server and its management, on *Ubuntu* and *Debian* variants including *Raspbian*. It currently supports:

.. hlist::
:columns: 5

* CouchPotato
* Emby
* Headphones
* HTPC Manager
* Lazy Librarian
* Mylar
* Nzbget
* NZBHydra
* Plex
* PlexPy
* PyLoad
* qBittorrent
* Radarr
* Sabnzbdplus
* Sickgear
* Sickrage
* Sonarr
* TransmissionBT
* Webmin

`rtinst <https://github.com/arakasi72/rtinst>`_

*bash · Trusty · Wheezy / Jessie*

Seedbox installation script for *Ubuntu* and *Debian* systems.

`Kerwood <https://github.com/Kerwood/rtorrent.auto.install>`_

*bash · Debian Jessie + Wheezy · Raspian*

Auto install script for *rTorrent*, with *ruTorrent* as the web client.


Installing from Source
----------------------

**TODO**
.. glossary::

`Installing (rTorrent wiki) <https://github.com/rakshasa/rtorrent/wiki/Installing>`_

Installation information and some trouble-shooting hints in the *rTorrent* wiki.

`Installing rTorrent-PS from Scratch <https://github.com/pyroscope/rtorrent-ps/blob/master/docs/DebianInstallFromSource.md#install-rtorrent-ps-and-pyrocore-on-debian-type-systems>`_

Installation instructions for a working *rTorrent* instance in combination with *PyroScope* from scratch, on *Debian* and most Debian-derived distros.

`Installation Guide (JES.SC) <https://jes.sc/kb/rTorrent+ruTorrent-Seedbox-Guide.php>`_

A single-page, comprehensive guide to take you step-by-step through installation and configuration
of *rTorrent* and *ruTorrent*.

`Installation How-To (LinOxide) <http://linoxide.com/ubuntu-how-to/setup-rtorrent-rutorrent/>`_

How to install / setup *rTorrent* and *ruTorrent* on *CentOS* or *Ubuntu*.

`Using rtorrent on Linux like a pro <http://ahotech.com/2010/06/30/tutorial-using-rtorrent-on-linux-like-a-pro/>`_

An oldie (originally from 2010), but still good.


rTorrent Distributions
----------------------

* `rTorrent-PS <https://github.com/pyroscope/rtorrent-ps#rtorrent-ps>`_ is a *rTorrent* distribution (not a fork of it), in form of a set of patches that improve the user experience and stability of official *rTorrent* releases. The notable additions are the more condensed ncurses UI with colorization and a network bandwidth graph, and a default configuration providing many new features, based in part on an extended command set.
* `rTorrent-PS-CH <https://github.com/chros73/rtorrent-ps_setup/wiki>`_ puts more patches and a different default configuration on top of *rTorrent-PS*. It also tries to work with the current git HEAD of *rTorrent*, which *rTorrent-PS* does not.
.. glossary::

`rTorrent-PS <https://github.com/pyroscope/rtorrent-ps#rtorrent-ps>`_

A *rTorrent* distribution (not a fork of it), in form of a set of patches that improve the user experience and stability of official *rTorrent* releases. The notable additions are the more condensed ncurses UI with colorization and a network bandwidth graph, and a default configuration providing many new features, based in part on an extended command set.

`rTorrent-PS-CH <https://github.com/chros73/rtorrent-ps_setup/wiki>`_

This puts more patches and a different default configuration on top of *rTorrent-PS*. It also tries to work with the current git HEAD of *rTorrent*, which *rTorrent-PS* does not.
2 changes: 1 addition & 1 deletion docs/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Overview

The :doc:`installation` has some pointers to common ways of installing
rTorrent on your machine. It does not provide yet another way to do that,
because there already are plentiful and redundant sources for that out there.
because there already are plentiful and redundant sources out there.

To help you with basic configuration tasks, the :doc:`cookbook`
contains a quick start into the ‘scripting language’ rTorrent uses
Expand Down

0 comments on commit 2fdf44c

Please sign in to comment.