mirror of
				https://github.com/spantaleev/matrix-docker-ansible-deploy.git
				synced 2025-10-30 23:07:57 +01:00 
			
		
		
		
	
		
			
				
	
	
		
			163 lines
		
	
	
		
			7.8 KiB
		
	
	
	
		
			Plaintext
		
	
	
	
	
	
			
		
		
	
	
			163 lines
		
	
	
		
			7.8 KiB
		
	
	
	
		
			Plaintext
		
	
	
	
	
	
| # SOME DESCRIPTIVE TITLE.
 | |
| # Copyright (C) 2018-2025, 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: 2025-01-27 09:54+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-bot-maubot.md:1
 | |
| msgid "Setting up maubot (optional)"
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:3
 | |
| msgid "The playbook can install and configure [maubot](https://github.com/maubot/maubot) for you."
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:5
 | |
| msgid "After setting up maubot, you can use the web management interface to make it do things. The default location of the management interface is `matrix.example.com/_matrix/maubot/`"
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:7
 | |
| msgid "See the project's [documentation](https://docs.mau.fi/maubot/usage/basic.html) to learn what it does and why it might be useful to you."
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:9
 | |
| msgid "Adjusting DNS records (optional)"
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:11
 | |
| msgid "By default, this playbook installs maubot on the `matrix.` subdomain, at the `/_matrix/maubot/` path (https://matrix.example.com/_matrix/maubot/). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**."
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:13
 | |
| msgid "If you wish to adjust it, see the section [below](#adjusting-the-maubot-url-optional) for details about DNS configuration."
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:15
 | |
| msgid "Adjusting the playbook configuration"
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:17
 | |
| msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:32
 | |
| msgid "You can add multiple admins. The admin accounts are only used to access the maubot administration interface."
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:34
 | |
| msgid "Adjusting the maubot URL (optional)"
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:36
 | |
| msgid "By tweaking the `matrix_bot_maubot_hostname` and `matrix_bot_maubot_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-bot-maubot.md:38
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:56
 | |
| msgid "Example additional configuration for your `vars.yml` file:"
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:46
 | |
| msgid "If you've changed the default hostname, you may need to create a CNAME record for the maubot domain (`maubot.example.com`), which targets `matrix.example.com`."
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:48
 | |
| msgid "When setting, replace `example.com` with your own."
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:50
 | |
| msgid "Customizing the maubot container image"
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:52
 | |
| msgid "Certain [maubot plugins](https://plugins.mau.bot/) require additional dependencies to be installed."
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:54
 | |
| msgid "You can customize the default maubot container image and install your own dependencies."
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:67
 | |
| msgid "Consult the [Dockerfile reference](https://docs.docker.com/reference/dockerfile/) for more information about the syntax."
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:69
 | |
| msgid "Installing"
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:71
 | |
| 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-bot-maubot.md:78
 | |
| msgid "**Notes**:"
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:80
 | |
| msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:82
 | |
| msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:84
 | |
| 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."
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:86
 | |
| msgid "If you change the bot password (`matrix_bot_maubot_initial_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_maubot_initial_password` to let the bot know its new password."
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:88
 | |
| msgid "Usage"
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:90
 | |
| msgid "By default, you can visit `matrix.example.com/_matrix/maubot/` to manage your available plugins, clients and instances."
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:92
 | |
| msgid "You should start in the following order"
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:93
 | |
| msgid "**Create one or more clients**: A client is a Matrix account which the bot will use to message. By default, the playbook creates a `bot.maubot` account (as per the configuration above). You only need to [obtain an access token](#obtaining-an-access-token) for it"
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:94
 | |
| msgid "**Upload some Plugins**: Plugins can be obtained from [here](https://github.com/maubot/maubot#plugins) or any other source."
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:95
 | |
| msgid "**Create an instance**: An instance is the actual bot. You have to specify a client which the bot instance will use and the plugin (how the bot will behave)"
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:97
 | |
| msgid "Obtain an access token"
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:99
 | |
| msgid "This can be done via `mbc login` then `mbc auth` (see the [maubot documentation](https://docs.mau.fi/maubot/usage/cli/auth.html)). To run these commands, you'll first need to `exec` into the maubot container with `docker exec -it matrix-bot-maubot sh`."
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:101
 | |
| msgid "Alternatively, you can refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md). Be aware that you'd better use the **Obtain an access token via curl** method (not **Obtain an access token via Element Web**) as the latter will causes issues to your bot in encrypted rooms. Read [more](https://docs.mau.fi/maubot/usage/basic.html#creating-clients)."
 | |
| msgstr ""
 | |
| 
 | |
| #: ../../../docs/configuring-playbook-bot-maubot.md:103
 | |
| msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone."
 | |
| msgstr ""
 |