* Make interface hidden behind proxy by default * Remove expose option and replace with http_bind_port Reasoning: This is a similar binary trigger but allows to bin not on all interfaces * Clarify maubot admin purpose * Remove unnecessary edif * Extend docs to prevent common misconceptions * Make http_bind_port singular, do not allow multiple values * Make optional againpull/1961/head
| @@ -18,7 +18,8 @@ matrix_bot_maubot_admins: | |||||
| - yourusername: securepassword | - yourusername: securepassword | ||||
| ``` | ``` | ||||
| You can add multiple admins. | |||||
| You can add multiple admins. The admin accounts are not connected to any matrix ID and are only used to access the | |||||
| maubot administration interface. | |||||
| ## Installing | ## Installing | ||||
| @@ -32,6 +33,13 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start | |||||
| ## Usage | ## Usage | ||||
| You can visit `matrix.<your-domain>/_matrix/maubot/` to manage your available plugins, clients and instances. | You can visit `matrix.<your-domain>/_matrix/maubot/` to manage your available plugins, clients and instances. | ||||
| You should start in the following order | |||||
| 1. **Create one or more clients:** A client is a matrix account which the bot will use to message. | |||||
| 2. **Upload some Plugins:** Plugins can be obtained from [here](https://github.com/maubot/maubot#plugins) or any other source. | |||||
| 3. **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) | |||||
| To add a client you first need to create an account and obtain a valid access token. | To add a client you first need to create an account and obtain a valid access token. | ||||
| ## Registering the bot user | ## Registering the bot user | ||||
| @@ -19,8 +19,7 @@ matrix_bot_maubot_data_path: "{{ matrix_bot_maubot_base_path }}/data" | |||||
| matrix_bot_maubot_config_path: "{{ matrix_bot_maubot_base_path }}/config" | matrix_bot_maubot_config_path: "{{ matrix_bot_maubot_base_path }}/config" | ||||
| matrix_bot_maubot_bot_server_public_url: "https://{{ matrix_server_fqn_matrix }}" | matrix_bot_maubot_bot_server_public_url: "https://{{ matrix_server_fqn_matrix }}" | ||||
| matrix_bot_maubot_proxy_management_interface: false | |||||
| matrix_bot_maubot_expose_management_interface: true | |||||
| matrix_bot_maubot_proxy_management_interface: true | |||||
| matrix_bot_maubot_database_engine: sqlite | matrix_bot_maubot_database_engine: sqlite | ||||
| matrix_bot_maubot_sqlite_database_path_local: "{{ matrix_bot_maubot_data_path }}/maubot.db" | matrix_bot_maubot_sqlite_database_path_local: "{{ matrix_bot_maubot_data_path }}/maubot.db" | ||||
| @@ -26,9 +26,9 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-bot-maubot \ | |||||
| {{ arg }} \ | {{ arg }} \ | ||||
| {% endfor %} | {% endfor %} | ||||
| --network={{ matrix_docker_network }} \ | --network={{ matrix_docker_network }} \ | ||||
| {% if matrix_bot_maubot_expose_management_interface|bool %} | |||||
| -p {{ matrix_bot_maubot_management_interface_port }}:29316 \ | |||||
| {% endif %} | |||||
| {% if matrix_bot_maubot_management_interface_http_bind_port | bool %} | |||||
| -p {{ matrix_bot_maubot_management_interface_http_bind_port }}:29316 | |||||
| {% endif %} | |||||
| {{ matrix_bot_maubot_docker_image }} \ | {{ matrix_bot_maubot_docker_image }} \ | ||||
| python3 -m maubot -c /data/config.yaml | python3 -m maubot -c /data/config.yaml | ||||