mirror of
https://github.com/matrixgpt/matrix-chatgpt-bot.git
synced 2024-06-30 00:21:42 +00:00
Descriptions added for all the env variables
This commit is contained in:
parent
2eccbf6d17
commit
30e6a0af9b
36
src/env.ts
36
src/env.ts
|
@ -28,27 +28,27 @@ export const {
|
||||||
OPENAI_LOGIN_TYPE,
|
OPENAI_LOGIN_TYPE,
|
||||||
CHATGPT_TIMEOUT
|
CHATGPT_TIMEOUT
|
||||||
} = parseEnv(process.env, {
|
} = parseEnv(process.env, {
|
||||||
DATA_PATH: {schema: z.string().default("./storage"), description: "Set to /storage/ if using docker, ./storage if running without"},
|
DATA_PATH: { schema: z.string().default("./storage"), description: "Set to /storage/ if using docker, ./storage if running without" },
|
||||||
/** Matrix Bot Settings */
|
/** Matrix Bot Settings */
|
||||||
MATRIX_HOMESERVER_URL: {schema: z.string().default("https://matrix.org")},
|
MATRIX_HOMESERVER_URL: { schema: z.string().default("https://matrix.org"), description: "Set matrix homeserver with 'https://' prefix" },
|
||||||
MATRIX_ACCESS_TOKEN: {schema: z.string().optional(), description: "Set MATRIX_BOT_USERNAME & MATRIX_BOT_PASSWORD to print MATRIX_ACCESS_TOKEN or follow https://webapps.stackexchange.com/questions/131056/how-to-get-an-access-token-for-element-riot-matrix"},
|
MATRIX_ACCESS_TOKEN: { schema: z.string().optional(), description: "Set MATRIX_BOT_USERNAME & MATRIX_BOT_PASSWORD to print MATRIX_ACCESS_TOKEN orfollow https://webapps.stackexchange.com/questions/131056/how-to-get-an-access-token-for-element-riot-matrix" },
|
||||||
MATRIX_BOT_USERNAME: {schema: z.string().optional(), description: "Set full username: eg @bot:server.com (superseded by MATRIX_ACCESS_TOKEN if set)"},
|
MATRIX_BOT_USERNAME: { schema: z.string().optional(), description: "Set full username: eg @bot:server.com (superseded by MATRIX_ACCESS_TOKEN if set)" },
|
||||||
MATRIX_BOT_PASSWORD: {schema: z.string().optional(), description: "Set password (superseded by MATRIX_ACCESS_TOKEN if set)"},
|
MATRIX_BOT_PASSWORD: { schema: z.string().optional(), description: "Set password (superseded by MATRIX_ACCESS_TOKEN if set)" },
|
||||||
/** Matrix Bot Features */
|
/** Matrix Bot Features */
|
||||||
MATRIX_AUTOJOIN: {schema: z.boolean().default(true)},
|
MATRIX_AUTOJOIN: { schema: z.boolean().default(true), description: "Set to true if you want the bot to autojoin when invited" },
|
||||||
MATRIX_ENCRYPTION: {schema: z.boolean().default(true)},
|
MATRIX_ENCRYPTION: { schema: z.boolean().default(true), description: "Set to true if you want the bot to support encrypted channels" },
|
||||||
MATRIX_THREADS: {schema: z.boolean().default(true)},
|
MATRIX_THREADS: { schema: z.boolean().default(true), description: "Set to true if you want the bot to answer always in a new thread/conversation" },
|
||||||
MATRIX_PREFIX_DM: {schema: z.boolean().default(false)},
|
MATRIX_PREFIX_DM: { schema: z.boolean().default(false), description: "Set to false if you want the bot to answer to all messages in a one-to-one room" },
|
||||||
MATRIX_RICH_TEXT: {schema: z.boolean().default(true)},
|
MATRIX_RICH_TEXT: { schema: z.boolean().default(true), description: "Set to true if you want the bot to answer with enriched text" },
|
||||||
/** Matrix Access Control */
|
/** Matrix Access Control */
|
||||||
MATRIX_BLACKLIST: {schema: z.string().optional()},
|
MATRIX_BLACKLIST: { schema: z.string().optional(), description: "Set to a spaces separated string of 'user:homeserver' or a wildcard like ':anotherhomeserver.example' to blacklist users or domains" },
|
||||||
MATRIX_WHITELIST: {schema: z.string().optional()},
|
MATRIX_WHITELIST: { schema: z.string().optional(), description: "Set to a spaces separated string of 'user:homeserver' or a wildcard like ':anotherhomeserver.example' to whitelist users or domains" },
|
||||||
/** Matrix Bot Runtime Config */
|
/** Matrix Bot Runtime Config */
|
||||||
MATRIX_DEFAULT_PREFIX: {schema: z.string().default(""), description: "Set this to empty string if you don't want to use it. Trailing space matters."},
|
MATRIX_DEFAULT_PREFIX: { schema: z.string().default(""), description: "Set this to empty string if you don't want to use it. Trailing space matters." },
|
||||||
MATRIX_DEFAULT_PREFIX_REPLY:{schema: z.boolean().default(false)},
|
MATRIX_DEFAULT_PREFIX_REPLY: { schema: z.boolean().default(false), description: "Set to false if you want the bot to answer to all messages in a thread/conversation" },
|
||||||
/** ChatGPT Settings */
|
/** ChatGPT Settings */
|
||||||
OPENAI_EMAIL: {schema: z.string().min(3)},
|
OPENAI_EMAIL: { schema: z.string().min(3), description: "Set full username of OpenAI's account" },
|
||||||
OPENAI_PASSWORD: {schema: z.string().min(1)},
|
OPENAI_PASSWORD: { schema: z.string().min(1), description: "Set password of OpenAI's account" },
|
||||||
OPENAI_LOGIN_TYPE: {schema: z.enum(["google", "openai", "microsoft"]).default("google")},
|
OPENAI_LOGIN_TYPE: { schema: z.enum(["google", "openai", "microsoft"]).default("google"), description: "Set authentication provider to 'google', 'openai' or 'microsoft'" },
|
||||||
CHATGPT_TIMEOUT: {schema: z.number().default(2 * 60 * 1000)}
|
CHATGPT_TIMEOUT: { schema: z.number().default(2 * 60 * 1000), description: "Set number of milliseconds to wait for CHATGPT responses" }
|
||||||
});
|
});
|
||||||
|
|
Loading…
Reference in New Issue
Block a user