https://github.com/elboletaire/ansible-transmission

:joystick: A TransmissionBT installation role for Ansible
https://github.com/elboletaire/ansible-transmission

ansible ansible-role role transmission transmission-daemon

Last synced: 15 days ago
JSON representation

:joystick: A TransmissionBT installation role for Ansible

• Host: GitHub
• URL: https://github.com/elboletaire/ansible-transmission
• Owner: elboletaire
• License: mit
• Created: 2015-08-18T22:59:36.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2021-09-13T20:55:57.000Z (about 3 years ago)
• Last Synced: 2024-04-16T00:40:17.344Z (7 months ago)
• Topics: ansible, ansible-role, role, transmission, transmission-daemon
• Language: Dockerfile
• Homepage:
• Size: 43 KB
• Stars: 12
• Watchers: 3
• Forks: 15
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Transmission BT Ansible Role

============================

[![Build status][build badge]][build]

[![Ansible galaxy][galaxy badge]][galaxy]

Ansible role for installing and configuring [Transmission](http://www.transmissionbt.com/).

Requirements

------------

Debian based system.

Installing

----------

You can easily install this role using `ansible-galaxy`:

```bash

ansible-galaxy install elboletaire.transmission -p roles

```

Variables

---------

There are no mandatory variables.

### Web interface & RPC

| Variable                                  | Default                 |

| ----------------------------------------- | ----------------------- |

| `transmission_password`                   |                         |

| `transmission_rpc_auth_required`          | `false`                 |

| `transmission_user`                       | `{{ ansible_user_id }}` |

| `transmission_rpc_whitelist_enabled`      | `true`                  |

| `transmission_rpc_whitelist`              | `127.0.0.1`             |

| `transmission_rpc_host_whitelist_enabled` | `true`                  |

| `transmission_rpc_host_whitelist`         | `""`                    |

| `transmission_url`                        | `/transmission/`        |

### Folders

| Variable                              | Default                              |

| ------------------------------------- | ------------------------------------ |

| `transmission_download_dir`           | `{{ ansible_env.HOME }}/downloads`   |

| `transmission_umask`                  | `2`                                  |

| `transmission_watch_dir_enabled`      | `true`                               |

| `transmission_watch_dir`              | `{{ ansible_env.HOME }}/torrents`    |

| `transmission_incomplete_dir_enabled` | `false`                              |

| `transmission_incomplete_dir`         | `{{ ansible_env.HOME }}/.incomplete` |

### Speed limits & ratio

| Variable                               | Default |

| ---------------------------------------| ------- |

| `transmission_speed_limit_up_enabled`  | `false` |

| `transmission_speed_limit_up`          | `100`   |

| `transmission_speed_limit_down_enabled`| `false` |

| `transmission_speed_limit_down`        | `100`   |

| `transmission_ratio_limit_enabled`     | `false` |

| `transmission_ratio_limit`             | `2`     |

### Blocklist

| Variable                         | Default                            |

| -------------------------------- | ---------------------------------- |

| `transmission_blocklist_enabled` | `false`                            |

| `transmission_blocklist_url`     | `http://www.example.com/blocklist` |

Please, refer to the

[transmission documentation](https://github.com/transmission/transmission/wiki/Editing-Configuration-Files)

to better understand this variables.

Example Playbook

----------------

A very simple example:

```yaml

- hosts: all

  roles:

    - role: transmission

      sudo: yes

```

A bit more complex example:

```yaml

- hosts: all

  roles:

    - role: transmission

      sudo: yes

      transmission_user: Krilin

      transmission_password: Bu1m4

      transmission_rpc_auth_required: true

      transmission_rpc_whitelist_enabled: true

      transmission_rpc_whitelist: "127.0.0.1,192.168.1.*"

```

License

-------

    The MIT License (MIT)

    Copyright (c) 2015 Oscar Casajuana 

    Permission is hereby granted, free of charge, to any person obtaining a copy

    of this software and associated documentation files (the "Software"), to deal

    in the Software without restriction, including without limitation the rights

    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

    copies of the Software, and to permit persons to whom the Software is

    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in

    all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

    THE SOFTWARE.

[build badge]: https://img.shields.io/gitlab/pipeline/elboletaire/ansible-transmission.svg?style=flat-square

[galaxy badge]: https://img.shields.io/ansible/role/5518.svg?style=flat-square

[build]: https://gitlab.com/elboletaire/ansible-transmission/pipelines

[galaxy]: https://galaxy.ansible.com/elboletaire/transmission/