aboutsummaryrefslogtreecommitdiffstats
path: root/roles/nitter
diff options
context:
space:
mode:
Diffstat (limited to 'roles/nitter')
-rw-r--r--roles/nitter/README.md53
-rw-r--r--roles/nitter/defaults/main.yml5
-rw-r--r--roles/nitter/vars/main.yml1
3 files changed, 54 insertions, 5 deletions
diff --git a/roles/nitter/README.md b/roles/nitter/README.md
new file mode 100644
index 0000000..d9d83ae
--- /dev/null
+++ b/roles/nitter/README.md
@@ -0,0 +1,53 @@
+Nitter
+======
+
+Description
+-----------
+
+The `gathio` role installs and configures [Nitter](https://github.com/zedeus/nitter),
+an open source Twitter frontend.
+
+This role configures the application only; it does not configure a reverse proxy.
+
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable | Default | Description
+-------------------------------|----------------------|------------
+`nitter_version` | `master` | Git version to install
+`nitter_server_name` | `{{ ansible_fqdn }}` | Canonical HTTP hostname
+`nitter_port` | 8080 | Local listening port
+`nitter_update_on_calendar` | `weekly` | Systemd [calendar interval](https://www.freedesktop.org/software/systemd/man/systemd.time.html#Calendar%20Events) for updating Nitter
+`nitter_hmac_key` |   | Random key for cryptographic signing of video URLs
+`nitter_max_connections` | 100 | Maximum number of HTTP connections
+`nitter_token_count` | 10 | Minimum number of API tokens
+`nitter_cache_list_minutes` | 240 | List cache duration (minutes)
+`nitter_cache_rss_minutes` | 10 | RSS cache duration (minutes)
+`nitter_redis_port` | 6379 | Port for local redis instance
+`nitter_redis_connections` | 20 | Redis connection pool size
+`nitter_redis_max_connections` | 30 | Maximum number of open redis connections
+
+This role **exports** the following variables:
+
+Variable | Description
+-----------------------|------------
+`nitter_apache_config` | Apache config block to configure a reverse proxy
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- hosts: nitter_servers
+ roles:
+ - role: nitter
+
+ - role: apache_vhost
+ apache_server_name: '{{ nitter_server_name }}'
+ apache_server_aliases: []
+ apache_config: '{{ nitter_apache_config }}'
+````
diff --git a/roles/nitter/defaults/main.yml b/roles/nitter/defaults/main.yml
index bac10c0..b7eefe9 100644
--- a/roles/nitter/defaults/main.yml
+++ b/roles/nitter/defaults/main.yml
@@ -3,19 +3,14 @@ nitter_version: master
nitter_server_name: '{{ ansible_fqdn }}'
nitter_port: 8080
-nitter_user: nitter
nitter_update_on_calendar: weekly
-nitter_hmac_key: secretKey
-
nitter_max_connections: 100
nitter_token_count: 10
nitter_cache_list_minutes: 240
nitter_cache_rss_minutes: 10
-nitter_redis_host: localhost
nitter_redis_port: 6379
-nitter_redis_password: ''
nitter_redis_connections: 20
nitter_redis_max_connections: 30
diff --git a/roles/nitter/vars/main.yml b/roles/nitter/vars/main.yml
index a7b0f3f..4c3e977 100644
--- a/roles/nitter/vars/main.yml
+++ b/roles/nitter/vars/main.yml
@@ -1,6 +1,7 @@
nitter_git_repo: https://github.com/zedeus/nitter
nitter_home: /opt/nitter
nitter_install_dir: '{{ nitter_home }}/nitter'
+nitter_user: nitter
nitter_packages:
- libsass