Admin guide
System settings
Root-only global site and operations configuration
System settings are organized into tabs covering site information, billing, payments, sign-in and registration, top navigation, and more. Only the Root role (role=100) can access them: open “Admin area → System settings” in the left sidebar, or go directly to `/console/setting`. Settings are read and written via `GET /api/option/` and `PUT /api/option/`. The web console page follows the reference design and is still being wired up.
General configuration
- Top-up link · Docs URL · Retry attempts · Quota display type
- Demo site mode · Self-use mode · Max tokens per user
Top bar management
System settings preview: tabs + general configuration form + top bar toggles
General settings
General options
| Setting | Field | Description |
|---|---|---|
| Top-up link | TopUpLink | URL of the user top-up page or an external checkout |
| Docs URL | DocumentationLink | Target of the “Docs” link at the top of the site, e.g. https://docs.example.com |
| Retry attempts | RetryTimes | Number of automatic retries when an upstream request fails |
| Quota display type | QuotaDisplayType | USD, CNY, or TOKEN; affects how the console and Model Square display amounts |
| Charge for quota queries | QuotaQueryEnabled | When enabled, deducts from the user's quota if the quota query API returns a non-zero balance |
| Default ratio name | DefaultRatioName | Default ratio label shown on the model pricing page |
| Demo site mode | DemoSiteEnabled | Restricts some write operations in demo environments |
| Self-use mode | SelfUseModeEnabled | Turns off public registration or restricts external distribution |
| Max tokens per user | MaxUserTokens | Maximum number of API tokens each user can create |
After making changes, click “Save general settings”, which calls PUT /api/setting and writes to the setting table. To read current values, use GET /api/settings.
Top bar management
Use the toggles to control which entries in the site's top bar are visible to users:
| Top bar item | Description |
|---|---|
| Home | Home entry in the site's top bar |
| Console | Console entry |
| Model Square | Model pricing list at /models |
| Docs | Docs center entry |
| Model Square details | Top bar entry for the model details page (optional) |
| About | About page entry |
Dashboard settings
Dashboard widgets and statistics range. For detailed fields and examples, see the corresponding section in System settings in detail.
Chat settings
Playground, default model for the chat page, and related toggles. For detailed fields and examples, see the corresponding section in System settings in detail.
Drawing settings
Parameters for image generation tasks such as Midjourney. For detailed fields and examples, see the corresponding section in System settings in detail.
Payment settings
Top-up and payment channels such as EPay, Stripe, and Creem. For detailed fields and examples, see the corresponding section in System settings in detail.
Group and model pricing settings
Group ratios, model ratios, and sync. For detailed fields and examples, see the corresponding section in System settings in detail.
Rate limit settings
Request rate limits site-wide or per model. For detailed fields and examples, see the corresponding section in System settings in detail.
Model settings
Model list, mappings, and global model policies. For detailed fields and examples, see the corresponding section in System settings in detail.
Performance settings
Performance options such as caching and connection pools. For detailed fields and examples, see the corresponding section in System settings in detail.
System settings
Core parameters such as database, log level, and maintenance mode. For detailed fields and examples, see the corresponding section in System settings in detail.
Other settings
OAuth, notifications, and miscellaneous toggles. For detailed fields and examples, see the corresponding section in System settings in detail.
Related notes
- Root only: regular admins (role=10) don't see the System settings tab, and the sidebar module
sidebar_modules.admin.settingis also available only to Root - Unlike Profile settings (
/setting), which covers the current user's account and security settings - Ratio sync is available via
POST /api/ratio_sync/fetch; reset model ratios withPOST /api/setting/rest_model_ratio - For third-party OAuth extensions, see Custom OAuth providers