Add funkwhale

docs/funkwhale.md

@@ -0,0 +1,161 @@
+# funkwhale
+
+[Funkwhale](funkwhale.audio/) is a community-driven project that lets you listen and share music and audio within a decentralized, open network.
+
+
+## Dependencies
+
+This service requires the following other services:
+
+- a [Postgres](postgres.md) database
+- a [Redis](redis.md) data-store, installation details [below](#redis)
+- a [Traefik](traefik.md) reverse-proxy server
+
+
+## Configuration
+
+To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process:
+
+```yaml
+########################################################################
+#                                                                      #
+# funkwhale                                                               #
+#                                                                      #
+########################################################################
+funkwhale_enabled: true
+funkwhale_hostname: mash.example.com
+# Put a strong secret below, generated with `pwgen -s 64 1` or in another way
+funkwhale_django_secret_key: ''
+# Redis configuration, as described below
+########################################################################
+#                                                                      #
+# /funkwhale                                                              #
+#                                                                      #
+########################################################################
+```
+
+### Redis
+
+As described on the [Redis](redis.md) documentation page, if you're hosting additional services which require Redis on the same server, you'd better go for installing a separate Redis instance for each service. See [Creating a Redis instance dedicated to funkwhale](#creating-a-redis-instance-dedicated-to-funkwhale).
+
+If you're only running funkwhale on this server and don't need to use Redis for anything else, you can [use a single Redis instance](#using-the-shared-redis-instance-for-funkwhale).
+
+#### Using the shared Redis instance for funkwhale
+
+To install a single (non-dedicated) Redis instance (`mash-redis`) and hook funkwhale to it, add the following **additional** configuration:
+
+```yaml
+########################################################################
+#                                                                      #
+# redis                                                                #
+#                                                                      #
+########################################################################
+redis_enabled: true
+########################################################################
+#                                                                      #
+# /redis                                                               #
+#                                                                      #
+########################################################################
+########################################################################
+#                                                                      #
+# funkwhale                                                               #
+#                                                                      #
+########################################################################
+# Base configuration as shown above
+# Point funkwhale to the shared Redis instance
+funkwhale_config_redis_hostname: "{{ redis_identifier }}"
+# Make sure the funkwhale service (mash-funkwhale.service) starts after the shared Redis service (mash-redis.service)
+funkwhale_systemd_required_services_list_custom:
+  - "{{ redis_identifier }}.service"
+# Make sure the funkwhale container is connected to the container network of the shared Redis service (mash-redis)
+funkwhale_container_additional_networks_custom:
+  - "{{ redis_identifier }}"
+########################################################################
+#                                                                      #
+# /funkwhale                                                              #
+#                                                                      #
+########################################################################
+```
+
+This will create a `mash-redis` Redis instance on this host.
+
+This is only recommended if you won't be installing other services which require Redis. Alternatively, go for [Creating a Redis instance dedicated to funkwhale](#creating-a-redis-instance-dedicated-to-funkwhale).
+
+
+#### Creating a Redis instance dedicated to funkwhale
+
+The following instructions are based on the [Running multiple instances of the same service on the same host](../running-multiple-instances.md) documentation.
+
+Adjust your `inventory/hosts` file as described in [Re-do your inventory to add supplementary hosts](../running-multiple-instances.md#re-do-your-inventory-to-add-supplementary-hosts), adding a new supplementary host (e.g. if `funkwhale.example.com` is your main one, create `funkwhale.example.com-deps`).
+
+Then, create a new `vars.yml` file for the
+
+`inventory/host_vars/funkwhale.example.com-deps/vars.yml`:
+
+```yaml
+---
+########################################################################
+#                                                                      #
+# Playbook                                                             #
+#                                                                      #
+########################################################################
+# Put a strong secret below, generated with `pwgen -s 64 1` or in another way
+# Various other secrets will be derived from this secret automatically.
+mash_playbook_generic_secret_key: ''
+# Override service names and directory path prefixes
+mash_playbook_service_identifier_prefix: 'mash-funkwhale-'
+mash_playbook_service_base_directory_name_prefix: 'funkwhale-'
+########################################################################
+#                                                                      #
+# /Playbook                                                            #
+#                                                                      #
+########################################################################
+########################################################################
+#                                                                      #
+# redis                                                                #
+#                                                                      #
+########################################################################
+redis_enabled: true
+########################################################################
+#                                                                      #
+# /redis                                                               #
+#                                                                      #
+########################################################################
+```
+
+This will create a `mash-funkwhale-redis` instance on this host with its data in `/mash/funkwhale-redis`.
+
+Then, adjust your main inventory host's variables file (`inventory/host_vars/funkwhale.example.com/vars.yml`) like this:
+
+```yaml
+########################################################################
+#                                                                      #
+# funkwhale                                                               #
+#                                                                      #
+########################################################################
+# Base configuration as shown above
+# Point funkwhale to its dedicated Redis instance
+funkwhale_environment_variable_redis_host: mash-funkwhale-redis
+funkwhale_environment_variable_redis_cache_host: mash-funkwhale-redis
+# Make sure the funkwhale service (mash-funkwhale.service) starts after its dedicated Redis service (mash-funkwhale-redis.service)
+funkwhale_systemd_required_services_list_custom:
+  - "mash-funkwhale-redis.service"
+# Make sure the funkwhale container is connected to the container network of its dedicated Redis service (mash-funkwhale-redis)
+funkwhale_container_additional_networks_custom:
+  - "mash-funkwhale-redis"
+########################################################################
+#                                                                      #
+# /funkwhale                                                              #
+#                                                                      #
+########################################################################
+```
+
+
+## Installation
+
+If you've decided to install a dedicated Redis instance for funkwhale, make sure to first do [installation](../installing.md) for the supplementary inventory host (e.g. `funkwhale.example.com-deps`), before running installation for the main one (e.g. `funkwhale.example.com`).
+
+
+## Usage
+
+After installation, you can go to the funkwhale URL, as defined in `funkwhale_hostname`.

docs/supported-services.md

@@ -11,6 +11,7 @@
 | [Docker Registry Purger](https://github.com/devture/docker-registry-purger) | A small tool used for purging a private Docker Registry's old tags | [Link](services/docker-registry-purger.md) |
 | [Focalboard](https://www.focalboard.com/) | An open source, self-hosted alternative to [Trello](https://trello.com/), [Notion](https://www.notion.so/), and [Asana](https://asana.com/). | [Link](services/focalboard.md) |
 | [Firezone](https://www.firezone.dev/) | A self-hosted VPN server (based on [WireGuard](https://en.wikipedia.org/wiki/WireGuard)) with a Web UI | [Link](services/firezone.md) |
+| [Funkwhale](https://funkwhale.audio/) | Listen and share music with a selfhosted streaming server.| [Link](services/funkwhale.md) |
 | [Gitea](https://gitea.io/) | A painless self-hosted [Git](https://git-scm.com/) service. | [Link](services/gitea.md) |
 | [GoToSocial](https://gotosocial.org/) | A self-hosted [ActivityPub](https://activitypub.rocks/) social network server | [Link](services/gotosocial.md) |
 | [Grafana](https://grafana.com/) | An open and composable observability and data visualization platform, often used with [Prometheus](services/prometheus.md) | [Link](services/grafana.md) |

group_vars/mash_servers

@@ -91,6 +91,14 @@ devture_systemd_service_manager_services_list_auto: |
     +
     ([{'name': (focalboard_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'focalboard']}] if focalboard_enabled else [])
     +
+    ([{'name': (funkwhale_api_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'funkwhale']}] if funkwhale_enabled else [])
+    +
+    ([{'name': (funkwhale_frontend_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'funkwhale']}] if funkwhale_enabled else [])
+    +
+    ([{'name': (funkwhale_celery_beat_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'funkwhale']}] if funkwhale_enabled else [])
+    +
+    ([{'name': (funkwhale_celery_worker_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'funkwhale']}] if funkwhale_enabled else [])
+    +
     ([{'name': (gitea_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'gitea', 'gitea-server']}] if gitea_enabled else [])
     +
     ([{'name': (gotosocial_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'gotosocial']}] if gotosocial_enabled else [])
@@ -188,6 +196,12 @@ devture_postgres_managed_databases_auto: |
       'password': focalboard_database_password,
     }] if focalboard_enabled and focalboard_database_type == 'postgres' and focalboard_database_hostname == devture_postgres_identifier else [])
     +
+    ([{
+      'name': funkwhale_database_name,
+      'username': funkwhale_database_username,
+      'password': funkwhale_database_password,
+    }] if funkwhale_enabled and funkwhale_database_hostname == devture_postgres_identifier else [])
+    +
     ([{
       'name': gitea_config_database_name,
       'username': gitea_config_database_username,

requirements.yml

@@ -50,6 +50,9 @@
 - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-focalboard.git
   version: v7.8.0-0
   name: focalboard
+- src: git+https://github.com/mother-of-all-self-hosting/ansible-role-funkwhale.git
+  version: v1.3.0-rc5-0
+  name: funkwhale
 - src: git+https://github.com/geerlingguy/ansible-role-docker
   version: 6.1.0
   name: geerlingguy.docker

setup.yml

@@ -66,6 +66,8 @@
 
     - role: galaxy/focalboard
 
+    - role: galaxy/funkwhale 
+
     - role: galaxy/gitea
 
     - role: galaxy/gotosocial