mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2024-12-23 13:05:47 +00:00
d4f8d0918a
Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3841 Most of the preparation for this was done by Suguru Hirahara (https://github.com/luixxiul). I've merely reorganized/polished the scripts and instructions in the `i18n/` directory. While translations can happen even now, more work is necessary to - make the translation flow better (integrating Weblate), etc. - restore the Github Actions workflows that Suguru Hirahara had already developed to adapt them to our new workflow
397 lines
14 KiB
Plaintext
397 lines
14 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>, 2024.
|
|
#
|
|
#, fuzzy
|
|
msgid ""
|
|
msgstr ""
|
|
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
|
"Report-Msgid-Bugs-To: \n"
|
|
"POT-Creation-Date: 2024-12-16 12:05+0900\n"
|
|
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
|
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
|
"Language: jp\n"
|
|
"Language-Team: jp <LL@li.org>\n"
|
|
"MIME-Version: 1.0\n"
|
|
"Content-Type: text/plain; charset=utf-8\n"
|
|
"Content-Transfer-Encoding: 8bit\n"
|
|
"Generated-By: Babel 2.16.0\n"
|
|
|
|
#: ../../../docs/configuring-well-known.md:1
|
|
msgid "Configuring Service Discovery via .well-known"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:3
|
|
msgid ""
|
|
"This documentation page explains how to configure Service discovery via "
|
|
"`/.well-known/` files. Service discovery is a way for the Matrix network "
|
|
"to discover where a Matrix server is."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:5
|
|
msgid "Types of well-known service discovery mechanism"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:7
|
|
msgid ""
|
|
"There are 3 types of well-known service discovery mechanism that Matrix "
|
|
"makes use of:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:9
|
|
msgid ""
|
|
"(important) **Federation Server discovery** (`/.well-"
|
|
"known/matrix/server`) -- assists other servers in the Matrix network with"
|
|
" finding your server. With the default playbook configuration specified "
|
|
"on the sample `vars.yml` ([`examples/vars.yml`](../examples/vars.yml)), "
|
|
"this is necessary for federation to work. Without a proper configuration,"
|
|
" your server will effectively not be part of the Matrix network."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:11
|
|
msgid ""
|
|
"(less important) **Client Server discovery** (`/.well-"
|
|
"known/matrix/client`) -- assists programs that you use to connect to your"
|
|
" server (e.g. Element Web), so that they can make it more convenient for "
|
|
"you by automatically configuring the \"Homeserver URL\" and \"Identity "
|
|
"Server URL\" addresses."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:13
|
|
msgid ""
|
|
"(optional) **Support service discovery** (`/.well-known/matrix/support`) "
|
|
"-- returns server admin contact and support page of the domain."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:15
|
|
msgid "Federation Server Discovery"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:17
|
|
msgid ""
|
|
"All services created by this playbook are meant to be installed on their "
|
|
"own server (such as `matrix.example.com`), instead of the base domain "
|
|
"(`example.com`)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:19
|
|
msgid ""
|
|
"As [per the Server-Server "
|
|
"specification](https://matrix.org/docs/spec/server_server/r0.1.0.html"
|
|
"#server-discovery), in order to use a short Matrix user ID like "
|
|
"`@alice:example.com` instead of `@alice:matrix.example.com` while hosting"
|
|
" services on a subdomain such as `matrix.example.com`, the Matrix network"
|
|
" needs to be instructed of [server delegation](howto-server-"
|
|
"delegation.md) / redirection."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:21
|
|
msgid ""
|
|
"For simplicity reasons, this playbook recommends you to set up server "
|
|
"delegation via a `/.well-known/matrix/server` file."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:23
|
|
msgid ""
|
|
"If you set up the DNS SRV record for server delegation instead, take a "
|
|
"look at this documentation for more information: [Server Delegation via a"
|
|
" DNS SRV record (advanced)](howto-server-delegation.md#server-delegation-"
|
|
"via-a-dns-srv-record-advanced)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:25
|
|
msgid "Client Server Discovery"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:27
|
|
msgid ""
|
|
"Client Server Service discovery lets various client programs which "
|
|
"support it, to receive a full user ID (e.g. `@alice:example.com`) and "
|
|
"determine where the Matrix server is automatically (e.g. "
|
|
"`https://matrix.example.com`)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:29
|
|
msgid ""
|
|
"This lets you (and your users) easily connect to your Matrix server "
|
|
"without having to customize connection URLs. When using client programs "
|
|
"that support it, you won't need to point them to "
|
|
"`https://matrix.example.com` in Custom Server options manually anymore. "
|
|
"The connection URL would be discovered automatically from your full "
|
|
"username."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:31
|
|
msgid ""
|
|
"Without /.well-known/matrix/client, the client will make the wrong "
|
|
"\"homeserver URL\" assumption (it will default to using "
|
|
"https://example.com, and users will need to notice and adjust it manually"
|
|
" (changing it to https://matrix.example.com)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:33
|
|
msgid ""
|
|
"As [per the Client-Server "
|
|
"specification](https://matrix.org/docs/spec/client_server/r0.4.0.html"
|
|
"#server-discovery) Matrix does Client Server service discovery using a "
|
|
"`/.well-known/matrix/client` file hosted on the base domain (e.g. "
|
|
"`example.com`)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:35
|
|
msgid ""
|
|
"However, this playbook installs your Matrix server on another domain "
|
|
"(e.g. `matrix.example.com`) and not on the base domain (e.g. "
|
|
"`example.com`), so it takes a little extra manual effort to set up the "
|
|
"file."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:37
|
|
msgid "(Optional) Support Service Discovery"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:39
|
|
msgid ""
|
|
"[MSC 1929](https://github.com/matrix-org/matrix-spec-"
|
|
"proposals/pull/1929), which was added to [Matrix Specification version "
|
|
"v1.10](https://spec.matrix.org/v1.10/client-server-api/#getwell-"
|
|
"knownmatrixsupport), specifies a way to add contact details of admins, as"
|
|
" well as a link to a support page for users who are having issues with "
|
|
"the service. Automated services may also index this information and use "
|
|
"it for abuse reports, etc."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:41
|
|
msgid ""
|
|
"To enable it, add the following configuration to your "
|
|
"`inventory/host_vars/matrix.example.com/vars.yml` file:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:62
|
|
msgid "Installing well-known files on the base domain's server"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:64
|
|
msgid ""
|
|
"To implement the service discovery mechanisms, your base domain's server "
|
|
"(e.g. `example.com`) needs to run an HTTPS-capable webserver."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:66
|
|
msgid "Serving the base domain from the Matrix server via the playbook"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:68
|
|
msgid ""
|
|
"If you don't have a server for your base domain at all, you can use the "
|
|
"Matrix server for this. If you don't need the base domain (e.g. "
|
|
"`example.com`) for anything else (hosting a website, etc.), you can point"
|
|
" it to the Matrix server's IP address and tell the playbook to configure "
|
|
"it."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:70
|
|
msgid ""
|
|
"**This is the easiest way to set up well-known serving** -- letting the "
|
|
"playbook handle the whole base domain for you (including SSL "
|
|
"certificates, etc.) and take care to serve the appropriate well-known "
|
|
"files automatically."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:72
|
|
msgid ""
|
|
"If you decide to go this route, you don't need to read ahead in this "
|
|
"document. Instead, go to [Serving the base domain](configuring-playbook-"
|
|
"base-domain-serving.md) to learn how the playbook can help you set it up."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:74
|
|
msgid ""
|
|
"However, if you need to use the base domain for other things, this method"
|
|
" is less suitable than the one explained below."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:76
|
|
msgid "Manually installing well-known files on the base domain's server"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:78
|
|
msgid ""
|
|
"If you're managing the base domain by yourself somehow, you'll need to "
|
|
"set up serving of some `/.well-known/matrix/*` files from it via HTTPS."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:80
|
|
msgid ""
|
|
"To make things easy for you to set up, this playbook generates and hosts "
|
|
"a few well-known files on the Matrix domain's server. The files are "
|
|
"generated at the `/matrix/static-files/public/.well-known/matrix/` path "
|
|
"on the server and hosted at URLs like `https://matrix.example.com/.well-"
|
|
"known/matrix/server` and `https://matrix.example.com/.well-"
|
|
"known/matrix/client`, even though this is the wrong place to host them."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:82
|
|
msgid ""
|
|
"You have two options when it comes to installing the files on the base "
|
|
"domain's server:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:84
|
|
msgid "(Option 1): **Copying the files manually** to your base domain's server"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:86
|
|
msgid ""
|
|
"**Hint**: Option 2 is generally a better way to do this. Make sure to go "
|
|
"with it, if possible."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:88
|
|
msgid "All you need to do is:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:90
|
|
msgid ""
|
|
"copy `/.well-known/matrix/server` and `/.well-known/matrix/client` from "
|
|
"the Matrix server (e.g. `matrix.example.com`) to your base domain's "
|
|
"server (`example.com`). You can find these files in the `/matrix/static-"
|
|
"files/.well-known/matrix` directory on the Matrix server. They are also "
|
|
"accessible on URLs like this: `https://matrix.example.com/.well-"
|
|
"known/matrix/server` (same for `client`)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:92
|
|
msgid ""
|
|
"set up the server at your base domain (e.g. `example.com`) so that it "
|
|
"adds an extra HTTP header when serving the `/.well-known/matrix/client` "
|
|
"file. [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS), the"
|
|
" `Access-Control-Allow-Origin` header should be set with a value of `*`. "
|
|
"If you don't do this step, web-based Matrix clients (like Element Web) "
|
|
"may fail to work. Setting up headers for the `/.well-known/matrix/server`"
|
|
" file is not necessary, as this file is only consumed by non-browsers, "
|
|
"which don't care about CORS."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:94
|
|
msgid ""
|
|
"This is relatively easy to do and possibly your only choice if you can "
|
|
"only host static files from the base domain's server. It is, however, **a"
|
|
" little fragile**, as future updates performed by this playbook may "
|
|
"regenerate the well-known files and you may need to notice that and copy "
|
|
"them over again."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:96
|
|
msgid ""
|
|
"(Option 2): **Setting up reverse-proxying** of the well-known files from "
|
|
"the base domain's server to the Matrix server"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:98
|
|
msgid "This option is less fragile and generally better."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:100
|
|
msgid ""
|
|
"On the base domain's server (e.g. `example.com`), you can set up reverse-"
|
|
"proxying, so that any access for the `/.well-known/matrix` location "
|
|
"prefix is forwarded to the Matrix domain's server (e.g. "
|
|
"`matrix.example.com`)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:102
|
|
msgid ""
|
|
"With this method, you **don't need** to add special HTTP headers for "
|
|
"[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) reasons "
|
|
"(like `Access-Control-Allow-Origin`), because your Matrix server (where "
|
|
"requests ultimately go) will be configured by this playbook correctly."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:104
|
|
msgid "**For nginx**, it would be something like this:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:121
|
|
msgid "**For Apache2**, it would be something like this:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:135
|
|
msgid "**For Caddy 2**, it would be something like this:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:145
|
|
msgid "**For HAProxy**, it would be something like this:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:164
|
|
msgid ""
|
|
"**For Netlify**, configure a "
|
|
"[redirect](https://docs.netlify.com/routing/redirects/) using a "
|
|
"`_redirects` file in the [publish directory](https://docs.netlify.com"
|
|
"/configure-builds/overview/#definitions) with contents like this:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:170
|
|
msgid "**For AWS CloudFront**"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:172
|
|
msgid "Add a custom origin with matrix.example.com to your distribution"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:173
|
|
msgid ""
|
|
"Add two behaviors, one for `.well-known/matrix/client` and one for "
|
|
"`.well-known/matrix/server` and point them to your new origin."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:175
|
|
msgid "Make sure to:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:177
|
|
msgid ""
|
|
"**replace `example.com`** in the server configuration with your actual "
|
|
"domain name"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:178
|
|
msgid ""
|
|
"and: to **do this for the HTTPS-enabled server block**, as that's where "
|
|
"Matrix expects the file to be"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:180
|
|
msgid "Confirming it works"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:182
|
|
msgid ""
|
|
"No matter which method you've used to set up the well-known files, if "
|
|
"you've done it correctly you should be able to see a JSON file at these "
|
|
"URLs:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:184
|
|
msgid "`https://example.com/.well-known/matrix/server`"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:185
|
|
msgid "`https://example.com/.well-known/matrix/client`"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:186
|
|
msgid "`https://example.com/.well-known/matrix/support`"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-well-known.md:188
|
|
msgid ""
|
|
"You can also check if everything is configured correctly, by [checking if"
|
|
" services work](maintenance-checking-services.md)."
|
|
msgstr ""
|
|
|