Matrix Bots: Difference between revisions
Initial |
m Sac moved page Matrix-bots-add ons to Matrix Bots |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<span id="matrix-bots-and-add-ons"></span> | |||
<span id="matrix-bots-and-add-ons"></span> | <span id="matrix-bots-and-add-ons"></span> | ||
= Matrix Bots and Add-Ons = | = Matrix Bots and Add-Ons = | ||
| Line 7: | Line 8: | ||
== GPT Bot == | == GPT Bot == | ||
https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/64db27c7faf3032341c665f8abf7aa66c7aa7aca/docs/configuring-playbook-bot-chatgpt.md?plain=1#L45 | For setting up a GPT-powered bot, follow the instructions provided in the official documentation: | ||
* [https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/64db27c7faf3032341c665f8abf7aa66c7aa7aca/docs/configuring-playbook-bot-chatgpt.md?plain=1#L45 Matrix-Docker-Ansible-Deploy GPT Bot Guide] | |||
=== Required Setup === | |||
Before proceeding, ensure you have the following: | |||
* '''OpenAI GPT Models''': Detailed information can be found [https://platform.openai.com/docs/models/gpt-4-and-gpt-4-turbo here]. | |||
* '''GPT API Key''': Generate your API key [https://platform.openai.com/api-keys here]. | |||
* '''Pricing Information''': Understand GPT pricing [https://openai.com/pricing here]. | |||
=== Setting Up a Bot Account with SSO === | |||
=== Setting | Follow these steps to create a bot account using SSO: | ||
# '''Create an account''': Register a bot account using your SSO provider. | |||
# Open a '''private browser window''' and log in to Matrix using the SSO. | |||
# Set up '''recovery keys''' for the account. | |||
# Obtain the '''access token''' for the bot account: | |||
## Navigate to '''All Settings''' in the Matrix client. | |||
## Go to '''Help & About'''. | |||
## Select '''Access Token''' and copy it. | |||
# '''DO NOT LOG OUT''': Keep the session active. | |||
# Close the browser to maintain the session state. | |||
# Use the obtained access token to configure the bot. | |||
'''Important Note:''' | |||
For SSO accounts, removing the local password option is required to allow recovery keys to be set up. Ensure this is configured correctly before proceeding. | |||
=== Setting Up an Account with an Access Token === | |||
Refer to the discussion and solutions provided in the [https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2556 GitHub Issue #2556] for detailed guidance on using an access token for account setup. | |||
[[Category:Matrix]] | |||
[[Category:Bots]] | |||
[[Category:OpenAI]] | |||
[[Category:Guides]] | |||
Latest revision as of 03:50, 21 November 2024
Matrix Bots and Add-Ons
Return to Matrix Server Guides
GPT Bot
For setting up a GPT-powered bot, follow the instructions provided in the official documentation:
Required Setup
Before proceeding, ensure you have the following:
- OpenAI GPT Models: Detailed information can be found here.
- GPT API Key: Generate your API key here.
- Pricing Information: Understand GPT pricing here.
Setting Up a Bot Account with SSO
Follow these steps to create a bot account using SSO:
- Create an account: Register a bot account using your SSO provider.
- Open a private browser window and log in to Matrix using the SSO.
- Set up recovery keys for the account.
- Obtain the access token for the bot account:
- Navigate to All Settings in the Matrix client.
- Go to Help & About.
- Select Access Token and copy it.
- DO NOT LOG OUT: Keep the session active.
- Close the browser to maintain the session state.
- Use the obtained access token to configure the bot.
Important Note: For SSO accounts, removing the local password option is required to allow recovery keys to be set up. Ensure this is configured correctly before proceeding.
Setting Up an Account with an Access Token
Refer to the discussion and solutions provided in the GitHub Issue #2556 for detailed guidance on using an access token for account setup.