Matrix Bots: Difference between revisions

No edit summary
No edit summary
Line 8: Line 8:


For setting up a GPT-powered bot, follow the instructions provided in the official documentation:
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]
* [external-link 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 ===
=== Required Setup ===
Before proceeding, ensure you have the following:
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].
* '''OpenAI GPT Models''': Detailed information can be found [external-link 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].
* '''GPT API Key''': Generate your API key [external-link https://platform.openai.com/api-keys here].
* **Pricing Information**: Understand GPT pricing [https://openai.com/pricing here].
* '''Pricing Information''': Understand GPT pricing [external-link https://openai.com/pricing here].


=== Setting Up a Bot Account with SSO ===
=== Setting Up a Bot Account with SSO ===
Follow these steps to create a bot account using SSO:
Follow these steps to create a bot account using SSO:


# **Create an account**: Register a bot account using your SSO provider.
# '''Create an account''': Register a bot account using your SSO provider.
# Open a **private browser window** and log in to Matrix using the SSO.
# Open a '''private browser window''' and log in to Matrix using the SSO.
# Set up **recovery keys** for the account.
# Set up '''recovery keys''' for the account.
# Obtain the **access token** for the bot account:
# Obtain the '''access token''' for the bot account:
## Navigate to **All Settings** in the Matrix client.
## Navigate to '''All Settings''' in the Matrix client.
## Go to **Help & About**.
## Go to '''Help & About'''.
## Select **Access Token** and copy it.
## Select '''Access Token''' and copy it.
# **DO NOT LOG OUT**: Keep the session active.
# '''DO NOT LOG OUT''': Keep the session active.
# Close the browser to maintain the session state.
# Close the browser to maintain the session state.
# Use the obtained access token to configure the bot.
# Use the obtained access token to configure the bot.
Line 34: Line 34:


=== Setting Up an Account with an Access Token ===
=== 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.
Refer to the discussion and solutions provided in the [external-link 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:Matrix]]