diff options
Diffstat (limited to 'docs/configuration/options.md')
| -rw-r--r-- | docs/configuration/options.md | 53 |
1 files changed, 0 insertions, 53 deletions
diff --git a/docs/configuration/options.md b/docs/configuration/options.md deleted file mode 100644 index b9c67806e..000000000 --- a/docs/configuration/options.md +++ /dev/null @@ -1,53 +0,0 @@ -# Configuration - -Configuration is controlled through the `Config` object. You can set configuration variables via the `.env` file. If you don't have a `.env` file, create a copy of `.env.template` in your `Auto-GPT` folder and name it `.env`. - -## Environment Variables - -- `AI_SETTINGS_FILE`: Location of AI Settings file. Default: ai_settings.yaml -- `AUDIO_TO_TEXT_PROVIDER`: Audio To Text Provider. Only option currently is `huggingface`. Default: huggingface -- `AUTHORISE_COMMAND_KEY`: Key response accepted when authorising commands. Default: y -- `BROWSE_CHUNK_MAX_LENGTH`: When browsing website, define the length of chunks to summarize. Default: 3000 -- `BROWSE_SPACY_LANGUAGE_MODEL`: [spaCy language model](https://spacy.io/usage/models) to use when creating chunks. Default: en_core_web_sm -- `CHAT_MESSAGES_ENABLED`: Enable chat messages. Optional -- `DISABLED_COMMAND_CATEGORIES`: Command categories to disable. Command categories are Python module names, e.g. autogpt.commands.execute_code. See the directory `autogpt/commands` in the source for all command modules. Default: None -- `ELEVENLABS_API_KEY`: ElevenLabs API Key. Optional. -- `ELEVENLABS_VOICE_ID`: ElevenLabs Voice ID. Optional. -- `EMBEDDING_MODEL`: LLM Model to use for embedding tasks. Default: text-embedding-ada-002 -- `EXECUTE_LOCAL_COMMANDS`: If shell commands should be executed locally. Default: False -- `EXIT_KEY`: Exit key accepted to exit. Default: n -- `FAST_LLM`: LLM Model to use for most tasks. Default: gpt-3.5-turbo -- `GITHUB_API_KEY`: [Github API Key](https://github.com/settings/tokens). Optional. -- `GITHUB_USERNAME`: GitHub Username. Optional. -- `GOOGLE_API_KEY`: Google API key. Optional. -- `GOOGLE_CUSTOM_SEARCH_ENGINE_ID`: [Google custom search engine ID](https://programmablesearchengine.google.com/controlpanel/all). Optional. -- `HEADLESS_BROWSER`: Use a headless browser while Auto-GPT uses a web browser. Setting to `False` will allow you to see Auto-GPT operate the browser. Default: True -- `HUGGINGFACE_API_TOKEN`: HuggingFace API, to be used for both image generation and audio to text. Optional. -- `HUGGINGFACE_AUDIO_TO_TEXT_MODEL`: HuggingFace audio to text model. Default: CompVis/stable-diffusion-v1-4 -- `HUGGINGFACE_IMAGE_MODEL`: HuggingFace model to use for image generation. Default: CompVis/stable-diffusion-v1-4 -- `IMAGE_PROVIDER`: Image provider. Options are `dalle`, `huggingface`, and `sdwebui`. Default: dalle -- `IMAGE_SIZE`: Default size of image to generate. Default: 256 -- `MEMORY_BACKEND`: Memory back-end to use. Currently `json_file` is the only supported and enabled backend. Default: json_file -- `MEMORY_INDEX`: Value used in the Memory backend for scoping, naming, or indexing. Default: auto-gpt -- `OPENAI_API_KEY`: *REQUIRED*- Your [OpenAI API Key](https://platform.openai.com/account/api-keys). -- `OPENAI_ORGANIZATION`: Organization ID in OpenAI. Optional. -- `PLAIN_OUTPUT`: Plain output, which disables the spinner. Default: False -- `PLUGINS_CONFIG_FILE`: Path of plugins_config.yaml file. Default: plugins_config.yaml -- `PROMPT_SETTINGS_FILE`: Location of Prompt Settings file. Default: prompt_settings.yaml -- `REDIS_HOST`: Redis Host. Default: localhost -- `REDIS_PASSWORD`: Redis Password. Optional. Default: -- `REDIS_PORT`: Redis Port. Default: 6379 -- `RESTRICT_TO_WORKSPACE`: The restrict file reading and writing to the workspace directory. Default: True -- `SD_WEBUI_AUTH`: Stable Diffusion Web UI username:password pair. Optional. -- `SD_WEBUI_URL`: Stable Diffusion Web UI URL. Default: http://localhost:7860 -- `SHELL_ALLOWLIST`: List of shell commands that ARE allowed to be executed by Auto-GPT. Only applies if `SHELL_COMMAND_CONTROL` is set to `allowlist`. Default: None -- `SHELL_COMMAND_CONTROL`: Whether to use `allowlist` or `denylist` to determine what shell commands can be executed (Default: denylist) -- `SHELL_DENYLIST`: List of shell commands that ARE NOT allowed to be executed by Auto-GPT. Only applies if `SHELL_COMMAND_CONTROL` is set to `denylist`. Default: sudo,su -- `SMART_LLM`: LLM Model to use for "smart" tasks. Default: gpt-4 -- `STREAMELEMENTS_VOICE`: StreamElements voice to use. Default: Brian -- `TEMPERATURE`: Value of temperature given to OpenAI. Value from 0 to 2. Lower is more deterministic, higher is more random. See https://platform.openai.com/docs/api-reference/completions/create#completions/create-temperature -- `TEXT_TO_SPEECH_PROVIDER`: Text to Speech Provider. Options are `gtts`, `macos`, `elevenlabs`, and `streamelements`. Default: gtts -- `USER_AGENT`: User-Agent given when browsing websites. Default: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.97 Safari/537.36" -- `USE_AZURE`: Use Azure's LLM Default: False -- `USE_WEB_BROWSER`: Which web browser to use. Options are `chrome`, `firefox`, `safari` or `edge` Default: chrome -- `WIPE_REDIS_ON_START`: Wipes data / index on start. Default: True |