hosting/cloudserve-infrastructure
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add monica deployment

Browse source 
Added basic monica docker deployment.

A key which is required for monica is automatically generated on
deployment.
Optionally, geolocation and weather api can be enabled.
Mail-sending functionality is disabled by default but can be enabled
with any compatible smtp server set up.
This commit is contained in:
Marty Oehme 2021-10-25 20:23:04 +02:00
parent 3f944df048
commit 010d8f93c4
Signed by: Marty
GPG key ID: B7538B8F50A1C800
12 changed files with 353 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

85
roles/monica/README.md Normal file
View file

@ -0,0 +1,85 @@
# monica
A minimalist rss feed reader.
Deployed in a docker swarm with caddy.
## Defaults
```
monica_upstream_file_dir: "{{ docker_stack_files_dir }}/{{ stack_name }}"
```
The on-target directory where the proxy configuration file should be stashed.
```
monica_use_https: true
```
Whether the service should be reachable through http (port 80) or through https (port 443) and provision an https certificate. Usually you will want this to stay `true`.
```
monica_version: latest
```
The docker image version to be used in stack creation.
```
subdomain_alias: prm
```
If the deployed container should be served over a uri that is not the stack name.
By default, it will be set to `prm.yourdomain.com` (personal relationship manager) -
if this option is not set it will be served on `monica.yourdomain.com` instead.
```
monica_db_root_password: mysupersecretdbrootpass
monica_db_username: mymonicadbusername
monica_db_password: mymonicadbpassword
```
Set the default username and password combination on first container start.
If loading from an existing volume this does nothing, otherwise it sets the
first user so you can instantly log in.
```
monica_app_disable_signups: true
```
Sets the behavior on the login screen ---
if set to true (default) will not let anyone but the first user sign up,
who automatically becomes an administrative user.
If set to false will allow multiple users to sign up on the instance.
```
monica_app_geolocation_api_key: <your-locationiq-key>
monica_app_weather_api_key: <your-darksky-key>
```
If `monica_app_geolocation_api_key` is set, Monica will translate addresses
input into the app to geographical latitude/ longitude data.
It requires an api key from https://locationiq.com/, which are free for
10.000 daily requests.
Similarly, if `monica_app_weather_api_key` is set, monica will (afaik) show
weather data for the location of individual contacts.
It requires an API key from https://darksky.net/dev/register, where
1.000 daily requests are free.
Be aware, however, that since darksky's sale to Apple, no new API signups are possible.
To use this feature, `monica_app_geolocation_api_key` must also be filled out.
```
monica_mail_host: smtp.eu.mailgun.org
monica_mail_port: 465
monica_mail_encryption: tls
monica_mail_username:
monica_mail_password:
monica_mail_from: monica@yourserver.com
monica_mail_from_name: Monica
monica_mail_new_user_notification_address: "{{ caddy_email }}"
```
Sets up the necessary details for Monica to send out registration and reminder e-mails.
Requires an smtp server set up, most easily doable through things like mailgun or sendgrid.
Variables should be relatively self-explanatory,
with `monica_mail_new_user_notification_address` being the address the notifications should be sent *to*,
so in all probability some sort of administration address.