| @@ -26,11 +26,11 @@ Draupnir for all only has limited support for external tooling like [MRU](https: | |||||
| ## Prerequisites | ## Prerequisites | ||||
| ### Prerequisites for Zero Touch Deployment (Recomended) | |||||
| ### Prerequisites for Zero Touch Deployment (Recommended) | |||||
| Zero Touch Deployment of Draupnir Appservice Mode (Draupnir for all) requires as of Draupnir 3.1.0 that you supply Draupnir the following: | Zero Touch Deployment of Draupnir Appservice Mode (Draupnir for all) requires as of Draupnir 3.1.0 that you supply Draupnir the following: | ||||
| - MXID of the the first person who gets invited to the admin room the bot creates for you. | |||||
| - MXID of the the first person who gets invited to the admin room the bot creates for you. | |||||
| That is all. The appservice manages everything on its own after you provide it a MXID to invite. | That is all. The appservice manages everything on its own after you provide it a MXID to invite. | ||||
| @@ -20,13 +20,13 @@ If your migrating from [Mjolnir](configuring-playbook-bot-mjolnir.md), skip to [ | |||||
| ## Prerequisites | ## Prerequisites | ||||
| ### Prerequisites for Zero Touch Deployment (Recomended) | |||||
| ### Prerequisites for Zero Touch Deployment (Recommended) | |||||
| Zero Touch Deployment of Draupnir bot mode requires as of Draupnir 3.1.0 that you supply Draupnir the following: | Zero Touch Deployment of Draupnir bot mode requires as of Draupnir 3.1.0 that you supply Draupnir the following: | ||||
| - MXID of the the first person who gets invited to the management room the bot creates for you. | |||||
| - Permanent access token for authentication. Instructions for obtaining one can be found at [obtain an access token via curl](obtaining-access-tokens.md#obtain-an-access-token-via-curl) | |||||
| - User account for Draupnir | |||||
| - MXID of the the first person who gets invited to the management room the bot creates for you. | |||||
| - Permanent access token for authentication. Instructions for obtaining one can be found at [obtain an access token via curl](obtaining-access-tokens.md#obtain-an-access-token-via-curl) | |||||
| - User account for Draupnir | |||||
| Zero Touch Deployment is the officially preferred installation method for new deployments of Draupnir as of 3.1.0 | Zero Touch Deployment is the officially preferred installation method for new deployments of Draupnir as of 3.1.0 | ||||
| @@ -78,7 +78,6 @@ matrix_bot_draupnir_config_accessToken: "CLEAN_ACCESS_TOKEN_HERE" | |||||
| To enable the bot, add the following configuration to your `vars.yml` file. Make sure to replace `INITIAL_MANAGER_MXID_HERE` with the MXID for whoever is to be invited to the management room first. | To enable the bot, add the following configuration to your `vars.yml` file. Make sure to replace `INITIAL_MANAGER_MXID_HERE` with the MXID for whoever is to be invited to the management room first. | ||||
| ```yaml | ```yaml | ||||
| # Enable Draupnir | # Enable Draupnir | ||||
| matrix_bot_draupnir_enabled: true | matrix_bot_draupnir_enabled: true | ||||
| @@ -176,6 +175,7 @@ curl --header "Authorization: Bearer ADMIN_ACCESS_TOKEN_HERE" -X POST https://ma | |||||
| ``` | ``` | ||||
| **Notes**: | **Notes**: | ||||
| - This does not work on outdated Windows 10 as curl is not available there. | - This does not work on outdated Windows 10 as curl is not available there. | ||||
| - Even if the APIs are not exposed to the internet, you should still be able to run the command on the homeserver locally. | - Even if the APIs are not exposed to the internet, you should still be able to run the command on the homeserver locally. | ||||
| @@ -163,7 +163,7 @@ msgid "Granting Users the ability to use D4A" | |||||
| msgstr "" | msgstr "" | ||||
| #: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:97 | #: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:97 | ||||
| msgid "Draupnir for all includes several security measures like that it only allows users that are on its allow list to ask for a bot. To add a user to this list we have 2 primary options. Using the chat to tell Draupnir to do this for us or if you want to automatically do it by sending `m.policy.rule.user` events that target the subject you want to allow provisioning for with the `org.matrix.mjolnir.allow` recomendation. Using the chat is recomended." | |||||
| msgid "Draupnir for all includes several security measures like that it only allows users that are on its allow list to ask for a bot. To add a user to this list we have 2 primary options. Using the chat to tell Draupnir to do this for us or if you want to automatically do it by sending `m.policy.rule.user` events that target the subject you want to allow provisioning for with the `org.matrix.mjolnir.allow` recomendation. Using the chat is recommended." | |||||
| msgstr "" | msgstr "" | ||||
| #: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:99 | #: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:99 | ||||
| @@ -162,7 +162,7 @@ msgid "Granting Users the ability to use D4A" | |||||
| msgstr "" | msgstr "" | ||||
| #: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:97 | #: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:97 | ||||
| msgid "Draupnir for all includes several security measures like that it only allows users that are on its allow list to ask for a bot. To add a user to this list we have 2 primary options. Using the chat to tell Draupnir to do this for us or if you want to automatically do it by sending `m.policy.rule.user` events that target the subject you want to allow provisioning for with the `org.matrix.mjolnir.allow` recomendation. Using the chat is recomended." | |||||
| msgid "Draupnir for all includes several security measures like that it only allows users that are on its allow list to ask for a bot. To add a user to this list we have 2 primary options. Using the chat to tell Draupnir to do this for us or if you want to automatically do it by sending `m.policy.rule.user` events that target the subject you want to allow provisioning for with the `org.matrix.mjolnir.allow` recomendation. Using the chat is recommended." | |||||
| msgstr "" | msgstr "" | ||||
| #: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:99 | #: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:99 | ||||
| @@ -65,7 +65,7 @@ matrix_appservice_draupnir_for_all_force_restart: "{{ | |||||
| # Draupnir requires `matrix_appservice_draupnir_for_all_config_adminRoom` to be | # Draupnir requires `matrix_appservice_draupnir_for_all_config_adminRoom` to be | ||||
| # unset and `matrix_appservice_draupnir_for_all_initialManager` to be a valid | # unset and `matrix_appservice_draupnir_for_all_initialManager` to be a valid | ||||
| # user ID. | # user ID. | ||||
| # Zero Touch Deployment is recomended for all new deployments. | |||||
| # Zero Touch Deployment is recommended for all new deployments. | |||||
| # New deployments that are exempt from this recomendation are assumed to be advanced users. | # New deployments that are exempt from this recomendation are assumed to be advanced users. | ||||
| # Who know what they are doing and have specific needs that require the flexibility of non-zero-touch-deployment mode. | # Who know what they are doing and have specific needs that require the flexibility of non-zero-touch-deployment mode. | ||||
| # Note that enabling this on an existing deployment will cause the bot to recreate the admin room. | # Note that enabling this on an existing deployment will cause the bot to recreate the admin room. | ||||