205 lines
7.6 KiB
Plaintext
205 lines
7.6 KiB
Plaintext
# For further descriptions of these settings see docs/configuration/options.md or go to docs.agpt.co
|
|
|
|
################################################################################
|
|
### AUTO-GPT - GENERAL SETTINGS
|
|
################################################################################
|
|
|
|
## OPENAI_API_KEY - OpenAI API Key (Example: my-openai-api-key)
|
|
OPENAI_API_KEY=your-openai-api-key
|
|
|
|
## EXECUTE_LOCAL_COMMANDS - Allow local command execution (Default: False)
|
|
# EXECUTE_LOCAL_COMMANDS=False
|
|
|
|
## RESTRICT_TO_WORKSPACE - Restrict file operations to workspace ./auto_gpt_workspace (Default: True)
|
|
# RESTRICT_TO_WORKSPACE=True
|
|
|
|
## USER_AGENT - Define the user-agent used by the requests library to browse website (string)
|
|
# USER_AGENT="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"
|
|
|
|
## AI_SETTINGS_FILE - Specifies which AI Settings file to use (defaults to ai_settings.yaml)
|
|
# AI_SETTINGS_FILE=ai_settings.yaml
|
|
|
|
## PLUGINS_CONFIG_FILE - The path to the plugins_config.yaml file (Default plugins_config.yaml)
|
|
# PLUGINS_CONFIG_FILE=plugins_config.yaml
|
|
|
|
## PROMPT_SETTINGS_FILE - Specifies which Prompt Settings file to use (defaults to prompt_settings.yaml)
|
|
# PROMPT_SETTINGS_FILE=prompt_settings.yaml
|
|
|
|
## OPENAI_API_BASE_URL - Custom url for the OpenAI API, useful for connecting to custom backends. No effect if USE_AZURE is true, leave blank to keep the default url
|
|
# the following is an example:
|
|
# OPENAI_API_BASE_URL=http://localhost:443/v1
|
|
|
|
## AUTHORISE COMMAND KEY - Key to authorise commands
|
|
# AUTHORISE_COMMAND_KEY=y
|
|
|
|
## EXIT_KEY - Key to exit AUTO-GPT
|
|
# EXIT_KEY=n
|
|
|
|
## PLAIN_OUTPUT - Plain output, which disables the spinner (Default: False)
|
|
# PLAIN_OUTPUT=False
|
|
|
|
## DISABLED_COMMAND_CATEGORIES - The list of categories of commands that are disabled (Default: None)
|
|
# DISABLED_COMMAND_CATEGORIES=
|
|
|
|
################################################################################
|
|
### LLM PROVIDER
|
|
################################################################################
|
|
|
|
## TEMPERATURE - Sets temperature in OpenAI (Default: 0)
|
|
# TEMPERATURE=0
|
|
|
|
## OPENAI_ORGANIZATION - Your OpenAI Organization key (Default: None)
|
|
# OPENAI_ORGANIZATION=
|
|
|
|
## USE_AZURE - Use Azure OpenAI or not (Default: False)
|
|
# USE_AZURE=False
|
|
|
|
################################################################################
|
|
### LLM MODELS
|
|
################################################################################
|
|
|
|
## SMART_LLM_MODEL - Smart language model (Default: gpt-3.5-turbo)
|
|
# SMART_LLM_MODEL=gpt-3.5-turbo
|
|
|
|
## FAST_LLM_MODEL - Fast language model (Default: gpt-3.5-turbo)
|
|
# FAST_LLM_MODEL=gpt-3.5-turbo
|
|
|
|
## EMBEDDING_MODEL - Model to use for creating embeddings
|
|
# EMBEDDING_MODEL=text-embedding-ada-002
|
|
|
|
################################################################################
|
|
### SHELL EXECUTION
|
|
################################################################################
|
|
|
|
## SHELL_COMMAND_CONTROL - Whether to use "allowlist" or "denylist" to determine what shell commands can be executed (Default: denylist)
|
|
# SHELL_COMMAND_CONTROL=denylist
|
|
|
|
## ONLY if SHELL_COMMAND_CONTROL is set to denylist:
|
|
## SHELL_DENYLIST - List of shell commands that ARE NOT allowed to be executed by Auto-GPT (Default: sudo,su)
|
|
# SHELL_DENYLIST=sudo,su
|
|
|
|
## ONLY if SHELL_COMMAND_CONTROL is set to allowlist:
|
|
## SHELL_ALLOWLIST - List of shell commands that ARE allowed to be executed by Auto-GPT (Default: None)
|
|
# SHELL_ALLOWLIST=
|
|
|
|
################################################################################
|
|
### MEMORY
|
|
################################################################################
|
|
|
|
### General
|
|
|
|
## MEMORY_BACKEND - Memory backend type
|
|
# MEMORY_BACKEND=json_file
|
|
|
|
## MEMORY_INDEX - Value used in the Memory backend for scoping, naming, or indexing (Default: auto-gpt)
|
|
# MEMORY_INDEX=auto-gpt
|
|
|
|
### Redis
|
|
|
|
## REDIS_HOST - Redis host (Default: localhost, use "redis" for docker-compose)
|
|
# REDIS_HOST=localhost
|
|
|
|
## REDIS_PORT - Redis port (Default: 6379)
|
|
# REDIS_PORT=6379
|
|
|
|
## REDIS_PASSWORD - Redis password (Default: "")
|
|
# REDIS_PASSWORD=
|
|
|
|
## WIPE_REDIS_ON_START - Wipes data / index on start (Default: True)
|
|
# WIPE_REDIS_ON_START=True
|
|
|
|
################################################################################
|
|
### IMAGE GENERATION PROVIDER
|
|
################################################################################
|
|
|
|
### Common
|
|
|
|
## IMAGE_PROVIDER - Image provider (Default: dalle)
|
|
# IMAGE_PROVIDER=dalle
|
|
|
|
## IMAGE_SIZE - Image size (Default: 256)
|
|
# IMAGE_SIZE=256
|
|
|
|
### Huggingface (IMAGE_PROVIDER=huggingface)
|
|
|
|
## HUGGINGFACE_IMAGE_MODEL - Text-to-image model from Huggingface (Default: CompVis/stable-diffusion-v1-4)
|
|
# HUGGINGFACE_IMAGE_MODEL=CompVis/stable-diffusion-v1-4
|
|
|
|
## HUGGINGFACE_API_TOKEN - HuggingFace API token (Default: None)
|
|
# HUGGINGFACE_API_TOKEN=
|
|
|
|
### Stable Diffusion (IMAGE_PROVIDER=sdwebui)
|
|
|
|
## SD_WEBUI_AUTH - Stable Diffusion Web UI username:password pair (Default: None)
|
|
# SD_WEBUI_AUTH=
|
|
|
|
## SD_WEBUI_URL - Stable Diffusion Web UI API URL (Default: http://localhost:7860)
|
|
# SD_WEBUI_URL=http://localhost:7860
|
|
|
|
################################################################################
|
|
### AUDIO TO TEXT PROVIDER
|
|
################################################################################
|
|
|
|
## AUDIO_TO_TEXT_PROVIDER - Audio-to-text provider (Default: huggingface)
|
|
# AUDIO_TO_TEXT_PROVIDER=huggingface
|
|
|
|
## HUGGINGFACE_AUDIO_TO_TEXT_MODEL - The model for HuggingFace to use (Default: CompVis/stable-diffusion-v1-4)
|
|
# HUGGINGFACE_AUDIO_TO_TEXT_MODEL=CompVis/stable-diffusion-v1-4
|
|
|
|
################################################################################
|
|
### GITHUB
|
|
################################################################################
|
|
|
|
## GITHUB_API_KEY - Github API key / PAT (Default: None)
|
|
# GITHUB_API_KEY=
|
|
|
|
## GITHUB_USERNAME - Github username (Default: None)
|
|
# GITHUB_USERNAME=
|
|
|
|
################################################################################
|
|
### WEB BROWSING
|
|
################################################################################
|
|
|
|
## HEADLESS_BROWSER - Whether to run the browser in headless mode (default: True)
|
|
# HEADLESS_BROWSER=True
|
|
|
|
## USE_WEB_BROWSER - Sets the web-browser driver to use with selenium (default: chrome)
|
|
# USE_WEB_BROWSER=chrome
|
|
|
|
## BROWSE_CHUNK_MAX_LENGTH - When browsing website, define the length of chunks to summarize (Default: 3000)
|
|
# BROWSE_CHUNK_MAX_LENGTH=3000
|
|
|
|
## BROWSE_SPACY_LANGUAGE_MODEL - spaCy language model](https://spacy.io/usage/models) to use when creating chunks. (Default: en_core_web_sm)
|
|
# BROWSE_SPACY_LANGUAGE_MODEL=en_core_web_sm
|
|
|
|
## GOOGLE_API_KEY - Google API key (Default: None)
|
|
# GOOGLE_API_KEY=
|
|
|
|
## GOOGLE_CUSTOM_SEARCH_ENGINE_ID - Google custom search engine ID (Default: None)
|
|
# GOOGLE_CUSTOM_SEARCH_ENGINE_ID=
|
|
|
|
################################################################################
|
|
### TEXT TO SPEECH PROVIDER
|
|
################################################################################
|
|
|
|
## TEXT_TO_SPEECH_PROVIDER - Which Text to Speech provider to use (Default: gtts)
|
|
# TEXT_TO_SPEECH_PROVIDER=gtts
|
|
|
|
### Only if TEXT_TO_SPEECH_PROVIDER=streamelements
|
|
## STREAMELEMENTS_VOICE - Voice to use for StreamElements (Default: Brian)
|
|
# STREAMELEMENTS_VOICE=Brian
|
|
|
|
### Only if TEXT_TO_SPEECH_PROVIDER=elevenlabs
|
|
## ELEVENLABS_API_KEY - Eleven Labs API key (Default: None)
|
|
# ELEVENLABS_API_KEY=
|
|
|
|
## ELEVENLABS_VOICE_ID - Eleven Labs voice ID (Example: None)
|
|
# ELEVENLABS_VOICE_ID=
|
|
|
|
################################################################################
|
|
### CHAT MESSAGES
|
|
################################################################################
|
|
|
|
## CHAT_MESSAGES_ENABLED - Enable chat messages (Default: False)
|
|
# CHAT_MESSAGES_ENABLED=False
|