mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2024-12-22 12:35:51 +00:00
130 lines
6.8 KiB
Plaintext
130 lines
6.8 KiB
Plaintext
# SOME DESCRIPTIVE TITLE.
|
|
# Copyright (C) 2018-2024, Slavi Pantaleev, Aine Etke, MDAD community members
|
|
# This file is distributed under the same license as the matrix-docker-ansible-deploy package.
|
|
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
|
|
#
|
|
#, fuzzy
|
|
msgid ""
|
|
msgstr ""
|
|
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
|
"Report-Msgid-Bugs-To: \n"
|
|
"POT-Creation-Date: 2024-12-20 09:53+0200\n"
|
|
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
|
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
|
"Language-Team: LANGUAGE <LL@li.org>\n"
|
|
"MIME-Version: 1.0\n"
|
|
"Content-Type: text/plain; charset=UTF-8\n"
|
|
"Content-Transfer-Encoding: 8bit\n"
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:1
|
|
msgid "Setting up the Sygnal push gateway (optional)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:3
|
|
msgid "The playbook can install and configure the [Sygnal](https://github.com/matrix-org/sygnal) push gateway for you."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:5
|
|
msgid "See the project's [documentation](https://github.com/matrix-org/sygnal/blob/master/README.md) to learn what it does and why it might be useful to you."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:7
|
|
msgid "**Note**: most people don't need to install their own gateway. As Sygnal's [Notes for application developers](https://github.com/matrix-org/sygnal/blob/master/docs/applications.md) documentation says:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:9
|
|
msgid "It is not feasible to allow end-users to configure their own Sygnal instance, because the Sygnal instance needs the appropriate FCM or APNs secrets that belong to the application."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:11
|
|
msgid "This optional playbook component is only useful to people who develop/build their own Matrix client applications themselves."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:13
|
|
msgid "Adjusting the playbook configuration"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:15
|
|
msgid "To enable Sygnal, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:43
|
|
msgid "For a more complete example of available fields and values they can take, see `roles/custom/matrix-sygnal/templates/sygnal.yaml.j2` (or the [upstream `sygnal.yaml.sample` configuration file](https://github.com/matrix-org/sygnal/blob/master/sygnal.yaml.sample))."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:45
|
|
msgid "Configuring [GCM/FCM](https://firebase.google.com/docs/cloud-messaging/) is easier, as it only requires that you provide some config values."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:47
|
|
msgid "To configure [APNS](https://developer.apple.com/notifications/) (Apple Push Notification Service), you'd need to provide one or more certificate files. To do that, the above example configuration:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:49
|
|
msgid "makes use of the [`aux` role](https://github.com/mother-of-all-self-hosting/ansible-role-aux) (and its `aux_file_definitions` variable) to make the playbook install files into `/matrix/sygnal/data` (the `matrix_sygnal_data_path` variable). See [`defaults/main.yml` file](https://github.com/mother-of-all-self-hosting/ansible-role-aux/blob/main/defaults/main.yml) of the `aux` role for usage examples. It also makes sure the files are owned by `matrix:matrix`, so that Sygnal can read them. Of course, you can also install these files manually yourself, if you'd rather not use `aux`."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:51
|
|
msgid "references these files in the Sygnal configuration (`matrix_sygnal_apps`) using a path like `/data/..` (the `/matrix/sygnal/data` directory on the host system is mounted into the `/data` directory inside the container)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:53
|
|
msgid "Adjusting the Sygnal URL"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:55
|
|
msgid "By default, this playbook installs Sygnal on the `sygnal.` subdomain (`sygnal.example.com`) and requires you to [adjust your DNS records](#adjusting-dns-records)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:57
|
|
msgid "By tweaking the `matrix_sygnal_hostname` and `matrix_sygnal_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:59
|
|
msgid "Example additional configuration for your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:70
|
|
msgid "Adjusting DNS records"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:72
|
|
msgid "Once you've decided on the domain and path, **you may need to adjust your DNS** records to point the Sygnal domain to the Matrix server."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:74
|
|
msgid "By default, you will need to create a CNAME record for `sygnal`. See [Configuring DNS](configuring-dns.md) for details about DNS changes."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:76
|
|
msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:78
|
|
msgid "Installing"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:80
|
|
msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:87
|
|
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:89
|
|
msgid "`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:91
|
|
msgid "Usage"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:93
|
|
msgid "To make use of your Sygnal installation, you'd need to build your own Matrix client application, which uses the same API keys (for [GCM/FCM](https://firebase.google.com/docs/cloud-messaging/)) and certificates (for [APNS](https://developer.apple.com/notifications/)) and is to your Sygnal URL endpoint (e.g. `https://sygnal.example.com`)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-sygnal.md:95
|
|
msgid "Refer to Sygnal's [Notes for application developers](https://github.com/matrix-org/sygnal/blob/master/docs/applications.md) document."
|
|
msgstr ""
|