Files
baibot-withmcp/docs/access.md
Slavi Pantaleev 946aa9d9e9 Initial commit
2024-09-12 13:44:06 +03:00

2.0 KiB

🔒 Access

This bot employs access control to decide who can use its services and manage its configuration.

👋 Joining rooms

The bot automatically joins rooms when invited by someone considered a bot user.

👥 Users

The bot will ignore messages (and room invitations) from unallowed users.

Users can use all the bot's features (💬 Text Generation, 🦻 Speech-to-Text, etc.), but cannot manage the bot's configuration.

The bot can be used by users that match some dynamically configured Matrix user id patterns.

The following commands are available:

  • Show the currently allowed users: !bai access users
  • Set the list of allowed users: !bai access set-users SPACE_SEPARATED_PATTERNS

Example patterns: @*:example.com @*:another.com @someone:company.org

👮‍♂️ Administrators

Administrators can manage the bot's configuration and access control.

The bot can be administrated by users that match some statically configured Matrix user id patterns.

Administrators cannot be changed without adjusting the bot's configuration on the server.

💼 Room-local agent managers

Room-local agent managers are users privileged to create their own agents (see !bai agent) in rooms. Letting regular users create agents which contact arbitrary network services may be a security issue.

No room-local agent manager patterns are configured, so new agents can only be created by administrators.

The following commands are available:

  • Show the currently allowed users: !bai access room-local-agent-managers
  • Set the list of allowed users: !bai access set-room-local-agent-managers SPACE_SEPARATED_PATTERNS

Example patterns: @*:synapse.127.0.0.1.nip.io @*:another.com @someone:company.org