Administration Guide
Learn how to deploy, configure, manage, and secure your Genbase instance.
Administration Guide
This guide provides essential information for administrators responsible for deploying, configuring, managing, and securing a Genbase instance (Engine backend and Studio frontend).
Overview
Administering Genbase involves several key areas:
- Deployment: Setting up and running the necessary services (Engine, Studio, Database).
- Configuration: Managing environment variables for database connections, LLM/Embedding API keys, authentication secrets, and other settings.
- User Management: Creating and managing user accounts and roles (Superuser vs. Regular User).
- System Settings: Configuring operational parameters like the default LLM.
- Database Management: Ensuring the database is set up correctly and handling migrations.
- Security: Managing authentication, authorization, and API keys.
Key Administration Tasks
Explore the following sections for detailed guidance on specific administrative tasks:
Deployment
Instructions for deploying Genbase using Docker (recommended) or running locally.
Configuration
Reference for all essential environment variables required by Engine and Studio.
User Management
Guide to managing user accounts and roles via the Studio UI (requires Superuser privileges).
LLM & Embedding Configuration
How to configure API keys to enable different LLM/Embedding providers and set the system default model.
Database Setup & Migrations
Information on setting up the PostgreSQL database and managing schema migrations with Alembic.
Security Considerations
Details on authentication (JWT), authorization (RBAC/Casbin), and Module API Keys for the LLM Gateway.
Proper administration is crucial for a stable, secure, and efficient Genbase deployment.