aboutsummaryrefslogtreecommitdiffstats
path: root/roles/gathio/README.md
blob: 16ac16975033c3850a529277ca0406e9e3d0a88a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
Gathio
======

Description
-----------

The `gathio` role installs and configures [Gathio](https://github.com/lowercasename/gathio),
a web application for managing public events.

This role configures the NodeJS application only; it does not configure a reverse
proxy.


Variables
---------

This role **accepts** the following variables:

Variable              | Default                             | Description
----------------------|-------------------------------------|------------
`gathio_version`      | `master`                            | Git version to install
`gathio_port`         | 8080                                | Local listening port
`gathio_from_address` | `events-noreply@{{ email_domain }}` | Email `From:` address for event notifications
`gathio_server_name`  | `{{ ansible_fqdn }}`                | Canonical HTTP hostname
`gathio_site_name`    | `gathio`                            | Site name used for page titles

This role **exports** the following variables:

Variable               | Description
-----------------------|------------
`gathio_apache_config` | Apache config block to configure a reverse proxy

Usage
-----

Example playbook:

````yaml
- hosts: gathio_servers
  roles:
    - role: gathio
      gathio_port: 8080
      gathio_from_address: events-noreply@example.com
      gathio_site_name: Example Org Events
      gathio_server_name: events.example.com

    - role: apache_vhost
      apache_server_name: '{{ gathio_server_name }}'
      apache_server_aliases: []
      apache_letsencrypt: yes
      apache_config: '{{ gathio_apache_config }}'
````