diff --git a/docs/configurations/environment-variables.mdx b/docs/configurations/environment-variables.mdx new file mode 100644 index 00000000..da352d2d --- /dev/null +++ b/docs/configurations/environment-variables.mdx @@ -0,0 +1,33 @@ +--- +title: "Environment Variables" +description: "Configure Presenton using environment variables." +--- + +Presenton can be customized and secured using environment variables. Below are the key variables you can set when running the app: + +- **`CAN_CHANGE_KEYS`**\ + Controls whether users can modify API keys through the app interface.\ + Set to `"false"` to keep keys hidden and unchangeable, or `"true"` to allow changes.\ + _Example:_ `CAN_CHANGE_KEYS="false"` +- **`LLM`**\ + Select which Large Language Model provider Presenton should use.\ + Supported values: `"openai"`, `"google"`, `"ollama"`.\ + _Example:_ `LLM="openai"` +- **`OPENAI_API_KEY`**\ + Your OpenAI API key. Required if `LLM` is set to `"openai"`.\ + _Example:_ `OPENAI_API_KEY="sk-xxxxxxxxxxxxxxxx"` +- **`GOOGLE_API_KEY`**\ + Your Google API key. Required if `LLM` is set to `"google"`.\ + _Example:_ `GOOGLE_API_KEY="AIzaSyXXXXXXXXXXXX"` +- **`OLLAMA_MODEL`**\ + The Ollama model name to use. Required if `LLM` is set to `"ollama"`.\ + _Example:_ `OLLAMA_MODEL="llama3.2:3b"` +- **`PEXELS_API_KEY`**\ + API key for the Pexels image service. Optional but recommended when using Ollama models to enhance image search.\ + _Example:_ `PEXELS_API_KEY="abcdef123456"` + +### Example: Running Presenton with Environment Variables + +```bash +docker run -it --name presenton -p 5000:80 -e LLM="openai" -e OPENAI_API_KEY="your_openai_api_key" -e CAN_CHANGE_KEYS="false" -v "./user_data:/app/user_data" ghcr.io/presenton/presenton:v0.3.0-beta +``` \ No newline at end of file diff --git a/docs/docs.json b/docs/docs.json index e30dbd76..7c12ab88 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -21,6 +21,12 @@ "development" ] }, + { + "group": "Configurations", + "pages": [ + "configurations/environment-variables", + ] + } { "group": "Essentials", "pages": [