/[sudobot]/trunk/docs/app/(docs)/configuration/system-config-schema/page.mdx
ViewVC logotype

Annotation of /trunk/docs/app/(docs)/configuration/system-config-schema/page.mdx

Parent Directory Parent Directory | Revision Log Revision Log


Revision 626 - (hide annotations)
Sat Sep 7 09:38:45 2024 UTC (6 months, 3 weeks ago) by rakinar2
File size: 2432 byte(s)
chore: sync with git

1 rakinar2 575 ---
2 rakinar2 626 title: System Configuration
3 rakinar2 575 short_name: System Configuration
4     ---
5    
6     # SudoBot System Configuration
7    
8     SudoBot's behavior can be customized using a comprehensive system configuration schema. This document provides an overview of key configuration options and how to tailor the bot to your needs.
9    
10     ## Overview
11    
12     The system configuration for SudoBot is defined using TypeScript and the `zod` library. The configuration schema provides a structured way to set various options, allowing you to customize the bot's behavior according to your preferences.
13    
14     ## Configuration Schema
15    
16     The [SystemConfigSchema](https://github.com/onesoft-sudo/sudobot/blob/main/src/types/SystemConfigSchema.ts) defines the entire system configuration. Refer to this file for detailed information on each configuration option.
17    
18     ## Emojis
19    
20     Customize emojis used by the bot. The `emojis` configuration allows you to set specific emoji strings for different purposes within the bot.
21    
22     ## System Admins
23    
24     Specify users with system admin privileges using the `system_admins` configuration. Users in this list have elevated access to manage and configure the bot.
25    
26     ## Snippets
27    
28     Configure snippet-related settings using the `snippets` configuration. This includes options like saving attachments with snippets.
29    
30     ## Presence
31    
32     Set the bot's name, status, and activity type using the `presence` configuration. Define the bot's online status, custom status message, and activity type.
33    
34     ## Commands
35    
36     Customize command-related options using the `commands` configuration. For example, enable or disable the mention prefix for commands.
37    
38     ## Logging
39    
40     Enable logging and specify channels for logs with the `logging` configuration. This section includes options to control various aspects of logging within the bot.
41    
42     ## API Status
43    
44     The `api` configuration provides information about the bot's API status. Check the operational status of the server and view related details such as server status and description.
45    
46     ## Extensions
47    
48     The `extensions` configuration allows you to control the default mode for extensions. Specify whether to enable or disable all extensions by default.
49    
50     ## Log Server
51    
52     Configure the log server using the `log_server` configuration. Options include enabling and auto-starting the log server.
53    
54     ## Debug Mode
55    
56     Enable or disable debug mode with the `debug_mode` configuration. Debug mode provides additional logging and information helpful for troubleshooting.

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26