diff options
| author | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-13 20:05:25 -0500 |
|---|---|---|
| committer | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-13 20:05:52 -0500 |
| commit | 8c2dccad6652a535a6c549a2c4133afd9eb251ed (patch) | |
| tree | 6760ba328fe606693601f9c1c51bfd7b010a974b /roles/gathio | |
| parent | 3e94667b6b73c588ea8503138b5e201b45686978 (diff) | |
| download | selfhosted-8c2dccad6652a535a6c549a2c4133afd9eb251ed.tar.gz selfhosted-8c2dccad6652a535a6c549a2c4133afd9eb251ed.zip | |
add docs
Diffstat (limited to 'roles/gathio')
| -rw-r--r-- | roles/gathio/README.md | 52 | ||||
| -rw-r--r-- | roles/gathio/defaults/main.yml | 1 | ||||
| -rw-r--r-- | roles/gathio/vars/main.yml | 2 |
3 files changed, 54 insertions, 1 deletions
diff --git a/roles/gathio/README.md b/roles/gathio/README.md new file mode 100644 index 0000000..16ac169 --- /dev/null +++ b/roles/gathio/README.md @@ -0,0 +1,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 }}' +```` diff --git a/roles/gathio/defaults/main.yml b/roles/gathio/defaults/main.yml index 5a6aa8c..fad7276 100644 --- a/roles/gathio/defaults/main.yml +++ b/roles/gathio/defaults/main.yml @@ -1,5 +1,4 @@ gathio_version: master -gathio_user: gathio gathio_port: 8080 gathio_from_address: 'events-noreply@{{ email_domain }}' gathio_server_name: '{{ ansible_fqdn }}' diff --git a/roles/gathio/vars/main.yml b/roles/gathio/vars/main.yml index 59854fd..5d2f6d6 100644 --- a/roles/gathio/vars/main.yml +++ b/roles/gathio/vars/main.yml @@ -10,6 +10,8 @@ gathio_git_repo: https://github.com/lowercasename/gathio gathio_home: /var/lib/gathio gathio_install_dir: '{{ gathio_home }}/gathio' +gathio_user: gathio + gathio_apache_config: | {{ apache_proxy_config }} ProxyPass / http://127.0.0.1:{{ gathio_port }}/ |