Administrator manual
This manual is for people who manage an organization or run the OpenBot service. OpenBot is headless. Management tasks use its API or tools. API examples here are part of the management task.
Choose your responsibility
Section titled “Choose your responsibility”| Role | Responsibility | Required access |
|---|---|---|
| Organization administrator | Members, roles, models, budgets, and shared services in one organization | The rights named on each page |
| Platform administrator | Platform settings, shared providers, and organization policy limits | Platform admin rights |
| Server operator | Install, update, back up, and monitor the service | Access to the server, database, storage, and keys |
An organization role does not give platform rights. Server access and platform API rights are separate. If a task needs another role, hand it to the person who holds that role.
Manage an organization
Section titled “Manage an organization”- Read organizations and members and permissions.
- Set up SSO and domains if your organization uses its own sign-in provider.
- Add models and providers, then set prices and budgets.
- Connect Channels, Computer providers, or secret providers as needed.
- Give members the client address and the user manual.
Run the platform
Section titled “Run the platform”- Read deployment and instance configuration.
- Set up the platform and sign-in provider.
- Set up file storage, Live models, and Code Mode when needed.
- Set App Index restrictions, and pair machines that you operate.
- Use the backup steps and error logs for ongoing service work.
Handle a problem
Section titled “Handle a problem”Check which organization and account the problem affects. Check membership, rights, and model availability first. A server failure belongs to the operator. Include its time and request ID so the operator can find the log. Keep source changes in the developer manual.