ansible/roles/galene/README.md

# Ansible Role Galene

Install and configure [Galene](https://galene.org) videoconference server.

## Table of content

<!-- ANSIBLE DOCSMITH TOC START -->
* [Role variables](#variables)
  * [`galene_version`](#variable-galene_version)
  * [`galene_http_port`](#variable-galene_http_port)
  * [`galene_turn`](#variable-galene_turn)
  * [`galene_user`](#variable-galene_user)
  * [`galene_group`](#variable-galene_group)
  * [`galene_base_directory`](#variable-galene_base_directory)
  * [`galene_data_directory`](#variable-galene_data_directory)
  * [`galene_groups_directory`](#variable-galene_groups_directory)
  * [`galene_recording_directory`](#variable-galene_recording_directory)
  * [`galene_static_directory`](#variable-galene_static_directory)
  * [`galene_domain`](#variable-galene_domain)
  * [`galene_config`](#variable-galene_config)
  * [`galene_groups`](#variable-galene_groups)
<!-- ANSIBLE DOCSMITH TOC END -->
<!-- ANSIBLE DOCSMITH MAIN START -->

## Role variables<a id="variables"></a>

The following variables can be configured for this role:

| Variable | Type | Required | Default | Description (abstract) |
|----------|------|----------|---------|------------------------|
| `galene_version` | `str` | No | `"galene-1.0"` | Reference (branch or tag) of the Galene git repository. |
| `galene_http_port` | `int` | No | `443` | Port to listen. |
| `galene_turn` | `str` | No | `":1194"` | TURN address. |
| `galene_user` | `str` | No | `"galene"` | Operating system user to run the service. |
| `galene_group` | `str` | No | `"galene"` | Operating system group to run the service. |
| `galene_base_directory` | `path` | No | `"/var/lib/galene"` | Path to the base directory. |
| `galene_data_directory` | `path` | No | `"{{ galene_base_directory }}/data"` | Path to the data directory. |
| `galene_groups_directory` | `path` | No | `"{{ galene_base_directory }}/groups"` | Path to the groups directory. |
| `galene_recording_directory` | `path` | No | `"{{ galene_base_directory }}/recordings"` | Path to the recordings directory. |
| `galene_static_directory` | `path` | No | `"{{ galene_base_directory }}/static"` | Path to the static directory. |
| `galene_domain` | `str` | No | N/A | Domain name.<br><br>Used to generate TLS certificates. |
| `galene_config` | `dict` | No | N/A | Custom settings.<br><br>Key is the name of the setting.<br><br>Value is the value of the setting.<br><br>See [The global configuration file](https://galene.org/galene.html#the-global-configuration-file). |
| `galene_groups` | `dict` | No | N/A | Dict of groups.<br><br>Key is the group name.<br><br>Value is the group definition.<br><br>See [Group definitions](https://galene.org/galene.html#group-definitions). |

### `galene_version`<a id="variable-galene_version"></a>

[*⇑ Back to ToC ⇑*](#toc)

Reference (branch or tag) of the Galene git repository.

- **Type**: `str`
- **Required**: No
- **Default**: `"galene-1.0"`



### `galene_http_port`<a id="variable-galene_http_port"></a>

[*⇑ Back to ToC ⇑*](#toc)

Port to listen.

- **Type**: `int`
- **Required**: No
- **Default**: `443`



### `galene_turn`<a id="variable-galene_turn"></a>

[*⇑ Back to ToC ⇑*](#toc)

TURN address.

- **Type**: `str`
- **Required**: No
- **Default**: `":1194"`



### `galene_user`<a id="variable-galene_user"></a>

[*⇑ Back to ToC ⇑*](#toc)

Operating system user to run the service.

- **Type**: `str`
- **Required**: No
- **Default**: `"galene"`



### `galene_group`<a id="variable-galene_group"></a>

[*⇑ Back to ToC ⇑*](#toc)

Operating system group to run the service.

- **Type**: `str`
- **Required**: No
- **Default**: `"galene"`



### `galene_base_directory`<a id="variable-galene_base_directory"></a>

[*⇑ Back to ToC ⇑*](#toc)

Path to the base directory.

- **Type**: `path`
- **Required**: No
- **Default**: `"/var/lib/galene"`



### `galene_data_directory`<a id="variable-galene_data_directory"></a>

[*⇑ Back to ToC ⇑*](#toc)

Path to the data directory.

- **Type**: `path`
- **Required**: No
- **Default**: `"{{ galene_base_directory }}/data"`



### `galene_groups_directory`<a id="variable-galene_groups_directory"></a>

[*⇑ Back to ToC ⇑*](#toc)

Path to the groups directory.

- **Type**: `path`
- **Required**: No
- **Default**: `"{{ galene_base_directory }}/groups"`



### `galene_recording_directory`<a id="variable-galene_recording_directory"></a>

[*⇑ Back to ToC ⇑*](#toc)

Path to the recordings directory.

- **Type**: `path`
- **Required**: No
- **Default**: `"{{ galene_base_directory }}/recordings"`



### `galene_static_directory`<a id="variable-galene_static_directory"></a>

[*⇑ Back to ToC ⇑*](#toc)

Path to the static directory.

- **Type**: `path`
- **Required**: No
- **Default**: `"{{ galene_base_directory }}/static"`



### `galene_domain`<a id="variable-galene_domain"></a>

[*⇑ Back to ToC ⇑*](#toc)

Domain name.

Used to generate TLS certificates.

- **Type**: `str`
- **Required**: No



### `galene_config`<a id="variable-galene_config"></a>

[*⇑ Back to ToC ⇑*](#toc)

Custom settings.

Key is the name of the setting.

Value is the value of the setting.

See [The global configuration file](https://galene.org/galene.html#the-global-configuration-file).

- **Type**: `dict`
- **Required**: No



### `galene_groups`<a id="variable-galene_groups"></a>

[*⇑ Back to ToC ⇑*](#toc)

Dict of groups.

Key is the group name.

Value is the group definition.

See [Group definitions](https://galene.org/galene.html#group-definitions).

- **Type**: `dict`
- **Required**: No




<!-- ANSIBLE DOCSMITH MAIN END -->

## Usage

Playbook example:

```yaml
- hosts: all
  roles:
    - jriou.general.galene
```

Then run the playbook:

```
ansible-playbook play.yml
```