From b9b9022cfb2ec5f342e61d5a1c6891f22bfd3b7b Mon Sep 17 00:00:00 2001
From: gibix <gibix@inventati.org>
Date: Sat, 26 Nov 2022 14:53:41 +0100
Subject: [PATCH] add missing variable in readme
---
README.md | 69 ++++++++++++++++++++++++++++---------------------------
1 file changed, 35 insertions(+), 34 deletions(-)
diff --git a/README.md b/README.md
index c5727b8..f0e0de9 100644
--- a/README.md
+++ b/README.md
@@ -108,40 +108,41 @@ Once installation is complete, run `/srv/funkwhale/virtualenv/bin/python /srv/fu
**Optional variables**
-| name | Default | Description |
-| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
-| `funkwhale_api_ip` | `127.0.0.1` | IP address with which to bind the Funkwhale server |
-| `funkwhale_api_port` | `5000` | Port with which to bind the Funkwhale server |
-| `funkwhale_config_path` | `/srv/funkwhale/config` | Path to Funkwhale's configuration directory |
-| `funkwhale_nginx_csp_policy` | `"default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; font-src 'self' data:; object-src 'none'; media-src 'self' data:"` | Content-Security-Policy header to us. You will need to tweak this if you're serving media files from a separate domain. |
-| `funkwhale_database_managed` | `true` | If `true`, the role will manage the database server and Funkwhale's database |
-| `funkwhale_database_name` | `funkwhale` | Name of the Funkwhale database to use |
-| `funkwhale_database_user` | `funkwhale` | Postgresql username to login as |
-| `funkwhale_env_vars` | `[]` | List of environment variables to append to the generated `.env` file. Example: `["AWS_ACCESS_KEY_ID=myawsid", "AWS_SECRET_ACCESS_KEY=myawskey"]` |
-| `funkwhale_external_storage_enabled` | `false` | If `true`, set up the proper configuration to use an external storage for media files |
-| `funkwhale_disable_django_admin` | `false` | If `true`, returns a 403 (Forbidden) for `/api/admin` |
-| `funkwhale_gunicorn_extra_args` | `""` | Additional args to pass to gunicorn in the `funkwhale-server.service` file. Refer to [gunicorn's documentation](https://docs.gunicorn.org/en/stable/settings.html) for possible options |
-| `funkwhale_install_path` | `/srv/funkwhale` | Path where frontend, api and virtualenv files should be stored (**no trailing slash**) |
-| `funkwhale_letsencrypt_certbot_flags` | `null` | Additional flags to pass to `certbot` |
-| `funkwhale_letsencrypt_enabled` | `true` | If `true`, will configure SSL with certbot and Let's Encrypt |
-| `funkwhale_media_path` | `/srv/funkwhale/data/media` | Path where audio and uploaded files should be stored (**no trailing slash**) |
-| `funkwhale_music_path` | `/srv/funkwhale/data/music` | Path to your existing music library, to use with [CLI import](https://docs.funkwhale.audio/admin/importing-music.html) (**no trailing slash**) |
-| `funkwhale_nginx_additional_config` | `""` | Additional nginx configuration to add to the Funkwhale `server{}` block |
-| `funkwhale_nginx_managed` | `true` | If `true`, will install and configure nginx |
-| `funkwhale_nginx_tls_configure_ciphers` | `true` | Set TLS ciphers, curves, etc, overriding any settings in http{} |
-| `funkwhale_nginx_max_body_size` | `100M` | Value of nginx's `max_body_size` parameter to use |
-| `funkwhale_protocol` | `https` | If set to `https`, will configure Funkwhale and Nginx to work behind HTTPS. Use `http` to completely disable SSL. |
-| `funkwhale_redis_managed` | `true` | If `true`, will install and configure redis |
-| `funkwhale_ssl_cert_path` | `` | Path to an existing SSL certificate to use (use in combination with `funkwhale_letsencrypt_enabled: false`) |
-| `funkwhale_ssl_key_path` | `` | Path to an existing SSL key to use (use in combination with `funkwhale_letsencrypt_enabled: false`) |
-| `funkwhale_static_path` | `/srv/funkwhale/data/static` | Path where Funkwhale static files should be stored |
-| `funkwhale_systemd_managed` | `true` | If `true`, will configure Funkwhale systemd services |
-| `funkwhale_systemd_after` | `redis.service postgresql.service` | Configuration used for Systemd `After=` directive. Modify it if you have a database or redis server on a separate host |
-| `funkwhale_systemd_service_name` | `funkwhale` | Name of the generated Systemd service, e.g when calling `systemctl start <xxx>` |
-| `funkwhale_username` | `funkwhale` | Username of the system user and owner of Funkwhale data, files and configuration |
-| `funkwhale_version` | `latest` | The version to install/upgrade to. You can also use `develop` to run the development branch |
-| `funkwhale_custom_pip_packages` | `[]` | A list of additional python packages to download |
-| `funkwhale_custom_settings` | `` | Some Python code to append to `api/config/settings/production.py`. Use funkwhale_custom_settings: | ` for multiline code. |
+| name | Default | Description |
+| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `funkwhale_api_ip` | `127.0.0.1` | IP address with which to bind the Funkwhale server |
+| `funkwhale_api_port` | `5000` | Port with which to bind the Funkwhale server |
+| `funkwhale_config_path` | `/srv/funkwhale/config` | Path to Funkwhale's configuration directory |
+| `funkwhale_nginx_csp_policy` | `"default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; font-src 'self' data:; object-src 'none'; media-src 'self' data:"` | Content-Security-Policy header to us. You will need to tweak this if you're serving media files from a separate domain. |
+| `funkwhale_database_managed` | `true` | If `true`, the role will manage the database server and Funkwhale's database |
+| `funkwhale_database_name` | `funkwhale` | Name of the Funkwhale database to use |
+| `funkwhale_database_user` | `funkwhale` | Postgresql username to login as |
+| `funkwhale_env_vars` | `[]` | List of environment variables to append to the generated `.env` file. Example: `["AWS_ACCESS_KEY_ID=myawsid", "AWS_SECRET_ACCESS_KEY=myawskey"]` |
+| `funkwhale_external_storage_enabled` | `false` | If `true`, set up the proper configuration to use an external storage for media files |
+| `funkwhale_disable_django_admin` | `false` | If `true`, returns a 403 (Forbidden) for `/api/admin` |
+| `funkwhale_gunicorn_extra_args` | `""` | Additional args to pass to gunicorn in the `funkwhale-server.service` file. Refer to [gunicorn's documentation](https://docs.gunicorn.org/en/stable/settings.html) for possible options |
+| `funkwhale_install_path` | `/srv/funkwhale` | Path where frontend, api and virtualenv files should be stored (**no trailing slash**) |
+| `funkwhale_letsencrypt_certbot_flags` | `null` | Additional flags to pass to `certbot` |
+| `funkwhale_letsencrypt_enabled` | `true` | If `true`, will configure SSL with certbot and Let's Encrypt |
+| `funkwhale_media_path` | `/srv/funkwhale/data/media` | Path where audio and uploaded files should be stored (**no trailing slash**) |
+| `funkwhale_music_path` | `/srv/funkwhale/data/music` | Path to your existing music library, to use with [CLI import](https://docs.funkwhale.audio/admin/importing-music.html) (**no trailing slash**) |
+| `funkwhale_nginx_additional_config` | `""` | Additional nginx configuration to add to the Funkwhale `server{}` block |
+| `funkwhale_nginx_managed` | `true` | If `true`, will install and configure nginx |
+| `funkwhale_nginx_tls_termination` | `true` | If `false`, disable SSL in nginx |
+
+| `funkwhale_nginx_tls_configure_ciphers` | `true` | Set TLS ciphers, curves, etc, overriding any settings in http{} |
+| `funkwhale_nginx_max_body_size` | `100M` | Value of nginx's `max_body_size` parameter to use |
+| `funkwhale_protocol` | `https` | If set to `https`, will configure Funkwhale and Nginx to work behind HTTPS. Use `http` to completely disable SSL. |
+| `funkwhale_redis_managed` | `true` | If `true`, will install and configure redis |
+| `funkwhale_ssl_cert_path` | `` | Path to an existing SSL certificate to use (use in combination with `funkwhale_letsencrypt_enabled: false`) | | `funkwhale_ssl_key_path` |`` | Path to an existing SSL key to use (use in combination with `funkwhale_letsencrypt_enabled: false`) |
+| `funkwhale_static_path` | `/srv/funkwhale/data/static` | Path where Funkwhale static files should be stored |
+| `funkwhale_systemd_managed` | `true` | If `true`, will configure Funkwhale systemd services |
+| `funkwhale_systemd_after` | `redis.service postgresql.service` | Configuration used for Systemd `After=` directive. Modify it if you have a database or redis server on a separate host |
+| `funkwhale_systemd_service_name` | `funkwhale` | Name of the generated Systemd service, e.g when calling `systemctl start <xxx>` |
+| `funkwhale_username` | `funkwhale` | Username of the system user and owner of Funkwhale data, files and configuration |
+| `funkwhale_version` | `latest` | The version to install/upgrade to. You can also use `develop` to run the development branch |
+| `funkwhale_custom_pip_packages` | `[]` | A list of additional python packages to download |
+| `funkwhale_custom_settings` | `` | Some Python code to append to`api/config/settings/production.py`. Use funkwhale_custom_settings: | ` for multiline code. |
**Installing from source**
--
GitLab