AutoGPT

1
################################################################################
2
### AutoGPT - GENERAL SETTINGS
3
################################################################################
4

5
## OPENAI_API_KEY - OpenAI API Key (Example: my-openai-api-key)
6
OPENAI_API_KEY=your-openai-api-key
7

8
## TELEMETRY_OPT_IN - Share telemetry on errors and other issues with the AutoGPT team, e.g. through Sentry.
9
##   This helps us to spot and solve problems earlier & faster. (Default: DISABLED)
10
# TELEMETRY_OPT_IN=true
11

12
## EXECUTE_LOCAL_COMMANDS - Allow local command execution (Default: False)
13
# EXECUTE_LOCAL_COMMANDS=False
14

15
### Workspace ###
16

17
## RESTRICT_TO_WORKSPACE - Restrict file operations to workspace ./data/agents/<agent_id>/workspace (Default: True)
18
# RESTRICT_TO_WORKSPACE=True
19

20
## DISABLED_COMMAND_CATEGORIES - The list of categories of commands that are disabled (Default: None)
21
# DISABLED_COMMAND_CATEGORIES=
22

23
## FILE_STORAGE_BACKEND - Choose a storage backend for contents
24
## Options: local, gcs, s3
25
# FILE_STORAGE_BACKEND=local
26

27
## STORAGE_BUCKET - GCS/S3 Bucket to store contents in
28
# STORAGE_BUCKET=autogpt
29

30
## GCS Credentials
31
# see https://cloud.google.com/storage/docs/authentication#libauth
32

33
## AWS/S3 Credentials
34
# see https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html
35

36
## S3_ENDPOINT_URL - If you're using non-AWS S3, set your endpoint here.
37
# S3_ENDPOINT_URL=
38

39
### Miscellaneous ###
40

41
## USER_AGENT - Define the user-agent used by the requests library to browse website (string)
42
# 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"
43

44
## AI_SETTINGS_FILE - Specifies which AI Settings file to use, relative to the AutoGPT root directory. (defaults to ai_settings.yaml)
45
# AI_SETTINGS_FILE=ai_settings.yaml
46

47
## PLUGINS_CONFIG_FILE - The path to the plugins_config.yaml file, relative to the AutoGPT root directory. (Default plugins_config.yaml)
48
# PLUGINS_CONFIG_FILE=plugins_config.yaml
49

50
## PROMPT_SETTINGS_FILE - Specifies which Prompt Settings file to use, relative to the AutoGPT root directory. (defaults to prompt_settings.yaml)
51
# PROMPT_SETTINGS_FILE=prompt_settings.yaml
52

53
## AUTHORISE COMMAND KEY - Key to authorise commands
54
# AUTHORISE_COMMAND_KEY=y
55

56
## EXIT_KEY - Key to exit AutoGPT
57
# EXIT_KEY=n
58

59
################################################################################
60
### LLM PROVIDER
61
################################################################################
62

63
## TEMPERATURE - Sets temperature in OpenAI (Default: 0)
64
# TEMPERATURE=0
65

66
## 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
67
# the following is an example:
68
# OPENAI_API_BASE_URL=http://localhost:443/v1
69

70
# OPENAI_API_TYPE=
71
# OPENAI_API_VERSION=
72

73
## OPENAI_FUNCTIONS - Enables OpenAI functions: https://platform.openai.com/docs/guides/gpt/function-calling
74
## Note: this feature is only supported by OpenAI's newer models.
75
# OPENAI_FUNCTIONS=False
76

77
## OPENAI_ORGANIZATION - Your OpenAI Organization key (Default: None)
78
# OPENAI_ORGANIZATION=
79

80
## USE_AZURE - Use Azure OpenAI or not (Default: False)
81
# USE_AZURE=False
82

83
## AZURE_CONFIG_FILE - The path to the azure.yaml file, relative to the folder containing this file. (Default: azure.yaml)
84
# AZURE_CONFIG_FILE=azure.yaml
85

86
# AZURE_OPENAI_AD_TOKEN=
87
# AZURE_OPENAI_ENDPOINT=
88

89
################################################################################
90
### LLM MODELS
91
################################################################################
92

93
## SMART_LLM - Smart language model (Default: gpt-4-turbo-preview)
94
# SMART_LLM=gpt-4-turbo-preview
95

96
## FAST_LLM - Fast language model (Default: gpt-3.5-turbo-0125)
97
# FAST_LLM=gpt-3.5-turbo-0125
98

99
## EMBEDDING_MODEL - Model to use for creating embeddings
100
# EMBEDDING_MODEL=text-embedding-3-small
101

102
################################################################################
103
### SHELL EXECUTION
104
################################################################################
105

106
## SHELL_COMMAND_CONTROL - Whether to use "allowlist" or "denylist" to determine what shell commands can be executed (Default: denylist)
107
# SHELL_COMMAND_CONTROL=denylist
108

109
## ONLY if SHELL_COMMAND_CONTROL is set to denylist:
110
## SHELL_DENYLIST - List of shell commands that ARE NOT allowed to be executed by AutoGPT (Default: sudo,su)
111
# SHELL_DENYLIST=sudo,su
112

113
## ONLY if SHELL_COMMAND_CONTROL is set to allowlist:
114
## SHELL_ALLOWLIST - List of shell commands that ARE allowed to be executed by AutoGPT (Default: None)
115
# SHELL_ALLOWLIST=
116

117
################################################################################
118
### IMAGE GENERATION PROVIDER
119
################################################################################
120

121
### Common
122

123
## IMAGE_PROVIDER - Image provider (Default: dalle)
124
# IMAGE_PROVIDER=dalle
125

126
## IMAGE_SIZE - Image size (Default: 256)
127
# IMAGE_SIZE=256
128

129
### Huggingface (IMAGE_PROVIDER=huggingface)
130

131
## HUGGINGFACE_IMAGE_MODEL - Text-to-image model from Huggingface (Default: CompVis/stable-diffusion-v1-4)
132
# HUGGINGFACE_IMAGE_MODEL=CompVis/stable-diffusion-v1-4
133

134
## HUGGINGFACE_API_TOKEN - HuggingFace API token (Default: None)
135
# HUGGINGFACE_API_TOKEN=
136

137
### Stable Diffusion (IMAGE_PROVIDER=sdwebui)
138

139
## SD_WEBUI_AUTH - Stable Diffusion Web UI username:password pair (Default: None)
140
# SD_WEBUI_AUTH=
141

142
## SD_WEBUI_URL - Stable Diffusion Web UI API URL (Default: http://localhost:7860)
143
# SD_WEBUI_URL=http://localhost:7860
144

145
################################################################################
146
### AUDIO TO TEXT PROVIDER
147
################################################################################
148

149
## AUDIO_TO_TEXT_PROVIDER - Audio-to-text provider (Default: huggingface)
150
# AUDIO_TO_TEXT_PROVIDER=huggingface
151

152
## HUGGINGFACE_AUDIO_TO_TEXT_MODEL - The model for HuggingFace to use (Default: CompVis/stable-diffusion-v1-4)
153
# HUGGINGFACE_AUDIO_TO_TEXT_MODEL=CompVis/stable-diffusion-v1-4
154

155
################################################################################
156
### GITHUB
157
################################################################################
158

159
## GITHUB_API_KEY - Github API key / PAT (Default: None)
160
# GITHUB_API_KEY=
161

162
## GITHUB_USERNAME - Github username (Default: None)
163
# GITHUB_USERNAME=
164

165
################################################################################
166
### WEB BROWSING
167
################################################################################
168

169
## HEADLESS_BROWSER - Whether to run the browser in headless mode (default: True)
170
# HEADLESS_BROWSER=True
171

172
## USE_WEB_BROWSER - Sets the web-browser driver to use with selenium (default: chrome)
173
# USE_WEB_BROWSER=chrome
174

175
## BROWSE_CHUNK_MAX_LENGTH - When browsing website, define the length of chunks to summarize (Default: 3000)
176
# BROWSE_CHUNK_MAX_LENGTH=3000
177

178
## BROWSE_SPACY_LANGUAGE_MODEL - spaCy language model](https://spacy.io/usage/models) to use when creating chunks. (Default: en_core_web_sm)
179
# BROWSE_SPACY_LANGUAGE_MODEL=en_core_web_sm
180

181
## GOOGLE_API_KEY - Google API key (Default: None)
182
# GOOGLE_API_KEY=
183

184
## GOOGLE_CUSTOM_SEARCH_ENGINE_ID - Google custom search engine ID (Default: None)
185
# GOOGLE_CUSTOM_SEARCH_ENGINE_ID=
186

187
################################################################################
188
### TEXT TO SPEECH PROVIDER
189
################################################################################
190

191
## TEXT_TO_SPEECH_PROVIDER - Which Text to Speech provider to use (Default: gtts)
192
## Options: gtts, streamelements, elevenlabs, macos
193
# TEXT_TO_SPEECH_PROVIDER=gtts
194

195
## STREAMELEMENTS_VOICE - Voice to use for StreamElements (Default: Brian)
196
# STREAMELEMENTS_VOICE=Brian
197

198
## ELEVENLABS_API_KEY - Eleven Labs API key (Default: None)
199
# ELEVENLABS_API_KEY=
200

201
## ELEVENLABS_VOICE_ID - Eleven Labs voice ID (Example: None)
202
# ELEVENLABS_VOICE_ID=
203

204
################################################################################
205
### CHAT MESSAGES
206
################################################################################
207

208
## CHAT_MESSAGES_ENABLED - Enable chat messages (Default: False)
209
# CHAT_MESSAGES_ENABLED=False
210

211
################################################################################
212
### LOGGING
213
################################################################################
214

215
## LOG_LEVEL - Set the minimum level to filter log output by. Setting this to DEBUG implies LOG_FORMAT=debug, unless LOG_FORMAT is set explicitly.
216
## Options: DEBUG, INFO, WARNING, ERROR, CRITICAL
217
# LOG_LEVEL=INFO
218

219
## LOG_FORMAT - The format in which to log messages to the console (and log files).
220
## Options: simple, debug, structured_google_cloud
221
# LOG_FORMAT=simple
222

223
## LOG_FILE_FORMAT - Normally follows the LOG_FORMAT setting, but can be set separately.
224
## Note: Log file output is disabled if LOG_FORMAT=structured_google_cloud.
225
# LOG_FILE_FORMAT=simple
226

227
## PLAIN_OUTPUT - Disables animated typing and the spinner in the console output. (Default: False)
228
# PLAIN_OUTPUT=False
229

230

231
################################################################################
232
### Agent Protocol Server Settings
233
################################################################################
234
## AP_SERVER_PORT - Specifies what port the agent protocol server will listen on. (Default: 8000)
235
## AP_SERVER_DB_URL - Specifies what connection url the agent protocol database will connect to (Default: Internal SQLite)
236
## AP_SERVER_CORS_ALLOWED_ORIGINS - Comma separated list of allowed origins for CORS. (Default: http://localhost:{AP_SERVER_PORT})
237
# AP_SERVER_PORT=8000
238
# AP_SERVER_DB_URL=sqlite:///data/ap_server.db
239
# AP_SERVER_CORS_ALLOWED_ORIGINS=
240