124 lines
6.4 KiB
YAML
124 lines
6.4 KiB
YAML
---
|
|
# matrix-registration is a simple python application to have a token based matrix registration
|
|
# See: https://zeratax.github.io/matrix-registration/
|
|
# Project source code URL: https://github.com/ZerataX/matrix-registration
|
|
|
|
matrix_registration_enabled: true
|
|
|
|
matrix_registration_container_image_self_build: false
|
|
matrix_registration_container_image_self_build_repo: "https://github.com/ZerataX/matrix-registration"
|
|
matrix_registration_container_image_self_build_branch: "{{ 'master' if matrix_registration_version == 'latest' else matrix_registration_version }}"
|
|
# Controls whether we'll be patching the dependencies in `setup.py` when self-building.
|
|
# Without patching, building will likely fail, because of the poor unbounded way dependencies are defined (e.g. `flask-limiter>=1.1.0`).
|
|
# This is an attempt to get matrix-registration in its current (outdated) version to build.
|
|
matrix_registration_container_image_self_build_python_dependencies_patch_enabled: true
|
|
|
|
matrix_registration_base_path: "{{ matrix_base_data_path }}/matrix-registration"
|
|
matrix_registration_config_path: "{{ matrix_registration_base_path }}/config"
|
|
matrix_registration_data_path: "{{ matrix_registration_base_path }}/data"
|
|
matrix_registration_docker_src_files_path: "{{ matrix_registration_base_path }}/docker-src"
|
|
|
|
# renovate: datasource=docker depName=zeratax/matrix-registration
|
|
matrix_registration_version: "v0.9.1"
|
|
|
|
matrix_registration_docker_image: "{{ matrix_registration_docker_image_name_prefix }}zeratax/matrix-registration:{{ matrix_registration_version }}"
|
|
matrix_registration_docker_image_name_prefix: "{{ 'localhost/' if matrix_registration_container_image_self_build else matrix_container_global_registry_prefix }}"
|
|
matrix_registration_docker_image_force_pull: "{{ matrix_registration_docker_image.endswith(':latest') }}"
|
|
|
|
# A list of extra arguments to pass to the container
|
|
matrix_registration_container_extra_arguments: []
|
|
|
|
# List of systemd services that matrix-registration.service depends on
|
|
matrix_registration_systemd_required_services_list: ['docker.service']
|
|
|
|
# List of systemd services that matrix-registration.service wants
|
|
matrix_registration_systemd_wanted_services_list: []
|
|
|
|
# Controls whether the matrix-registration container exposes its HTTP port (tcp/5000 in the container).
|
|
#
|
|
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8767"), or empty string to not expose.
|
|
matrix_registration_container_http_host_bind_port: ''
|
|
|
|
# Database-related configuration fields.
|
|
#
|
|
# To use SQLite, stick to these defaults.
|
|
#
|
|
# To use Postgres:
|
|
# - change the engine (`matrix_registration_database_engine: 'postgres'`)
|
|
# - adjust your database credentials via the `matrix_registration_database_*` variables
|
|
matrix_registration_database_engine: 'sqlite'
|
|
|
|
matrix_registration_sqlite_database_path_local: "{{ matrix_registration_data_path }}/db.sqlite3"
|
|
matrix_registration_sqlite_database_path_in_container: "/data/db.sqlite3"
|
|
|
|
matrix_registration_database_username: 'matrix_registration'
|
|
matrix_registration_database_password: 'some-password'
|
|
matrix_registration_database_hostname: ''
|
|
matrix_registration_database_port: 5432
|
|
matrix_registration_database_name: 'matrix_registration'
|
|
|
|
matrix_registration_database_connection_string: 'postgresql://{{ matrix_registration_database_username }}:{{ matrix_registration_database_password }}@{{ matrix_registration_database_hostname }}:{{ matrix_registration_database_port }}/{{ matrix_registration_database_name }}'
|
|
|
|
# For some reason, matrix-registraiton expects the `db` field to be like this: `sqlite:////data/db.sqlite3`.
|
|
# (seems like one too many slashes, but..)
|
|
matrix_registration_db: "{{
|
|
{
|
|
'sqlite': ('sqlite:///' + matrix_registration_sqlite_database_path_in_container),
|
|
'postgres': matrix_registration_database_connection_string,
|
|
}[matrix_registration_database_engine]
|
|
}}"
|
|
|
|
|
|
# The path at which Matrix Registration will be exposed on `matrix.DOMAIN`
|
|
# (only applies when matrix-nginx-proxy is used).
|
|
matrix_registration_public_endpoint: /matrix-registration
|
|
|
|
matrix_registration_base_url: "{{ matrix_registration_public_endpoint }}"
|
|
|
|
matrix_registration_api_register_endpoint: "{{ matrix_homeserver_url }}{{ matrix_registration_public_endpoint }}/register"
|
|
matrix_registration_api_token_endpoint: "{{ matrix_homeserver_url }}{{ matrix_registration_public_endpoint }}/token"
|
|
|
|
matrix_registration_api_validate_certs: true
|
|
|
|
# The URL to your homeserver (e.g.: `https://matrix.DOMAIN`).
|
|
# A local (in-container address) is preferable.
|
|
matrix_registration_server_location: ""
|
|
|
|
matrix_registration_server_name: "{{ matrix_domain }}"
|
|
|
|
# matrix_registration_shared_secret needs to match the homeserver's registration secret.
|
|
# For Synapse, that's the `registration_shared_secret` setting.
|
|
matrix_registration_shared_secret: ""
|
|
|
|
# matrix_registration_admin_secret is your own admin secret for using matrix-registration (creating new tokens, etc.)
|
|
matrix_registration_admin_secret: ""
|
|
|
|
matrix_registration_riot_instance: "https://riot.im/app/"
|
|
|
|
# Default matrix-registration configuration template which covers the generic use case.
|
|
# You can customize it by controlling the various variables inside it.
|
|
#
|
|
# For a more advanced customization, you can extend the default (see `matrix_registration_configuration_extension_yaml`)
|
|
# or completely replace this variable with your own template.
|
|
matrix_registration_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
|
|
|
|
matrix_registration_configuration_extension_yaml: |
|
|
# Your custom YAML configuration for registration goes here.
|
|
# This configuration extends the default starting configuration (`matrix_registration_configuration_yaml`).
|
|
#
|
|
# You can override individual variables from the default configuration, or introduce new ones.
|
|
#
|
|
# If you need something more special, you can take full control by
|
|
# completely redefining `matrix_registration_configuration_yaml`.
|
|
#
|
|
# Example configuration extension follows:
|
|
#
|
|
# password:
|
|
# min_length: 12
|
|
|
|
matrix_registration_configuration_extension: "{{ matrix_registration_configuration_extension_yaml | from_yaml if matrix_registration_configuration_extension_yaml | from_yaml is mapping else {} }}"
|
|
|
|
# Holds the final matrix-registration configuration (a combination of the default and its extension).
|
|
# You most likely don't need to touch this variable. Instead, see `matrix_registration_configuration_yaml`.
|
|
matrix_registration_configuration: "{{ matrix_registration_configuration_yaml | from_yaml | combine(matrix_registration_configuration_extension, recursive=True) }}"
|