<commit_before>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` | `false`                 |
| `transmission_rpc_whitelist`         | `127.0.0.1`             |
| `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://trac.transmissionbt.com/wiki/EditConfigFiles)
to better understand this variables.

Example Playbook
----------------

A very simple example:<commit_msg>Point documentation link to GitHub<commit_after>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` | `false`                 |
| `transmission_rpc_whitelist`         | `127.0.0.1`             |
| `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:
{'fraction_non_alphanumeric': 0.21706422018348623, 'fraction_numerical': 0.005137614678899082, 'mean_word_length': 1.446588868940754, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 12, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5227795', 'n_tokens_mistral': 1452, 'n_tokens_neox': 1390, 'n_words': 237}