readme-vars.yml

---

# project information
project_name: rutorrent
project_url: "https://github.com/Novik/ruTorrent"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/rutorrent.jpg"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) is a popular rtorrent client with a webui for ease of use."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"

# supported architectures
available_architectures:
  - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
  - { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"}

# container parameters
common_param_env_vars_enabled: true #PGID, PUID, etc
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
  - { vol_path: "/config", vol_host_path: "</path/to/{{ project_name }}/config>", desc: "where ruTorrent should store it's config files" }
  - { vol_path: "/downloads", vol_host_path: "</path/to/{{ project_name }}/downloads>", desc: "path to your downloads folder" }
param_usage_include_ports: true
param_ports:
  - { external_port: "80", internal_port: "80", port_desc: "ruTorrent Web UI" }
  - { external_port: "5000", internal_port: "5000", port_desc: "scgi port" }
  - { external_port: "51413", internal_port: "51413", port_desc: "Bit-torrent port" }
  - { external_port: "6881", internal_port: "6881/udp", port_desc: "Bit-torrent port" }
param_usage_include_env: true

# application setup block
app_setup_block_enabled: true
app_setup_block: |
  THIS IMAGE IS DEPRECATED. Please migrate to [crazy-max's image](https://github.com/crazy-max/docker-rtorrent-rutorrent).

  Webui can be found at `<your-ip>:80` , configuration files for rtorrent are in /config/rtorrent, php in config/php and for the webui in /config/rutorrent/settings.

  `Settings, changed by the user through the "Settings" panel in ruTorrent, are valid until rtorrent restart. After which all settings will be set according to the rtorrent config file (/config/rtorrent/rtorrent.rc),this is a limitation of the actual apps themselves.`

  ** Important note for unraid users or those running services such as a webserver on port 80, change port 80 assignment **

  `** It should also be noted that this container when run will create subfolders ,completed, incoming and watched in the /downloads volume.**`

  ** The Port Assignments and configuration folder structure has been changed from the previous ubuntu based versions of this container and we recommend a clean install **

  Umask can be set in the /config/rtorrent/rtorrent.rc file by changing value in `system.umask.set`

  If you are seeing this error `Caught internal_error: 'DhtRouter::get_tracker did not actually insert tracker.'.` , a possible fix is to disable dht in `/config/rtorrent/rtorrent.rc` by changing the following values.

  ```shell
  dht.mode.set = disable
  protocol.pex.set = no
  ```

  If after updating you see an error about connecting to rtorrent in the webui,
  remove or comment out these lines in /config/rtorrent/rtorrent.rc ,whatever value is set, yes or no.
  Just setting them to no will still cause the error..

  ```
  trackers.use_udp.set = yes
  protocol.pex.set = no
  ```
  To add plugins, create a `plugins` folder in your /config directory and add your plugin folders. Ensure proper user and group ownership is set once you add the directories.
  To add themes, create a themes folder in your /config directory and add your theme folders. Ensure proper user and group ownership is set once you add the directories.

# changelog
changelogs:
  - { date: "25.03.22:", desc: "Deprecated. Please migrate to [crazy-max's image](https://github.com/crazy-max/docker-rtorrent-rutorrent)." }
  - { date: "02.06.20:", desc: "Rebasing to alpine 3.12." }
  - { date: "29.02.20:", desc: "Update readme for pex/dht." }
  - { date: "28.06.19:", desc: "Rebasing to alpine 3.10." }
  - { date: "20.05.19:", desc: "Shift to building from official releases instead of commits." }
  - { date: "13.05.19:", desc: "Add libffi and openssl." }
  - { date: "07.05.19:", desc: "Add cloudscraper pip package." }
  - { date: "11.04.19:", desc: "Fix warnings in webui by adding python3, procps and pip packages." }
  - { date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag." }
  - { date: "22.02.19:", desc: "Rebasing to alpine 3.9." }
  - { date: "03.11.18:", desc: "Add pipeline and multi arch logic to repo." }
  - { date: "27.08.18:", desc: "Add bind tools package." }
  - { date: "22.08.18:", desc: "Rebase to alpine 3.8." }
  - { date: "08.12.17:", desc: "Rebase to alpine 3.7, add sox package." }
  - { date: "28.10.17:", desc: "Mediainfo moved from testing to community repo." }
  - { date: "09.10.17:", desc: "Use repo version of mediainfo to shorten build time." }
  - { date: "28.05.17:", desc: "Fix permissions on secondary temp folder of nginx." }
  - { date: "26.05.17:", desc: "Rebase to alpine 3.6." }
  - { date: "03.05.17:", desc: "Fix log permissions." }
  - { date: "18.03.17:", desc: "Note in readme about disabling dht in some circumstances." }
  - { date: "24.02.17:", desc: "Patch a source file to quash rss https bug." }
  - { date: "29.01.17:", desc: "Rebase to alpine 3.5." }
  - { date: "20.11.16:", desc: "Add php7-mbstring package, bump mediainfo to 0.7.90." }
  - { date: "14.10.16:", desc: "Add version layer information." }
  - { date: "04.10.16:", desc: "Remove redundant sessions folder." }
  - { date: "30.09.16:", desc: "Fix umask." }
  - { date: "21.09.16:", desc: "Bump mediainfo, reorg dockerfile, add full wget package." }
  - { date: "09.09.16:", desc: "Add layer badges to README." }
  - { date: "28.08.16:", desc: "Add badges to README, bump mediainfo version to 0.7.87." }
  - { date: "07.08.16:", desc: "Perms fix on nginx tmp folder, also exposed php.ini for editing by use in /config/php." }
  - { date: "26.07.16:", desc: "Rebase to alpine." }
  - { date: "08.03.16:", desc: "Initial Release." }