1 files changed, 233 insertions, 0 deletions
diff --git a/autogpts/autogpt/.env.template b/autogpts/autogpt/.env.template
new file mode 100644
index 000000000..9ec564a5d
--- /dev/null
+++ b/autogpts/autogpt/.env.template
@@ -0,0 +1,233 @@
+################################################################################
+### AutoGPT - 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
+
+### Workspace ###
+
+## RESTRICT_TO_WORKSPACE - Restrict file operations to workspace ./data/agents/<agent_id>/workspace (Default: True)
+# RESTRICT_TO_WORKSPACE=True
+
+## DISABLED_COMMAND_CATEGORIES - The list of categories of commands that are disabled (Default: None)
+# DISABLED_COMMAND_CATEGORIES=
+
+## WORKSPACE_BACKEND - Choose a storage backend for workspace contents
+## Options: local, gcs, s3
+# WORKSPACE_BACKEND=local
+
+## WORKSPACE_STORAGE_BUCKET - GCS/S3 Bucket to store workspace contents in
+# WORKSPACE_STORAGE_BUCKET=autogpt
+
+## GCS Credentials
+# see https://cloud.google.com/storage/docs/authentication#libauth
+
+## AWS/S3 Credentials
+# see https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html
+
+## S3_ENDPOINT_URL - If you're using non-AWS S3, set your endpoint here.
+# S3_ENDPOINT_URL=
+
+### Miscellaneous ###
+
+## 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, relative to the AutoGPT root directory. (defaults to ai_settings.yaml)
+# AI_SETTINGS_FILE=ai_settings.yaml
+
+## PLUGINS_CONFIG_FILE - The path to the plugins_config.yaml file, relative to the AutoGPT root directory. (Default plugins_config.yaml)
+# PLUGINS_CONFIG_FILE=plugins_config.yaml
+
+## PROMPT_SETTINGS_FILE - Specifies which Prompt Settings file to use, relative to the AutoGPT root directory. (defaults to prompt_settings.yaml)
+# PROMPT_SETTINGS_FILE=prompt_settings.yaml
+
+## AUTHORISE COMMAND KEY - Key to authorise commands
+# AUTHORISE_COMMAND_KEY=y
+
+## EXIT_KEY - Key to exit AutoGPT
+# EXIT_KEY=n
+
+################################################################################
+### LLM PROVIDER
+################################################################################
+
+## TEMPERATURE - Sets temperature in OpenAI (Default: 0)
+# TEMPERATURE=0
+
+## 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
+
+# OPENAI_API_TYPE=
+# OPENAI_API_VERSION=
+
+## OPENAI_FUNCTIONS - Enables OpenAI functions: https://platform.openai.com/docs/guides/gpt/function-calling
+## Note: this feature is only supported by OpenAI's newer models.
+# OPENAI_FUNCTIONS=False
+
+## OPENAI_ORGANIZATION - Your OpenAI Organization key (Default: None)
+# OPENAI_ORGANIZATION=
+
+## USE_AZURE - Use Azure OpenAI or not (Default: False)
+# USE_AZURE=False
+
+## AZURE_CONFIG_FILE - The path to the azure.yaml file, relative to the folder containing this file. (Default: azure.yaml)
+# AZURE_CONFIG_FILE=azure.yaml
+
+# AZURE_OPENAI_AD_TOKEN=
+# AZURE_OPENAI_ENDPOINT=
+
+################################################################################
+### LLM MODELS
+################################################################################
+
+## SMART_LLM - Smart language model (Default: gpt-4-0314)
+# SMART_LLM=gpt-4-0314
+
+## FAST_LLM - Fast language model (Default: gpt-3.5-turbo-16k)
+# FAST_LLM=gpt-3.5-turbo-16k
+
+## 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 AutoGPT (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 AutoGPT (Default: None)
+# SHELL_ALLOWLIST=
+
+################################################################################
+### 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)
+## Options: gtts, streamelements, elevenlabs, macos
+# TEXT_TO_SPEECH_PROVIDER=gtts
+
+## STREAMELEMENTS_VOICE - Voice to use for StreamElements (Default: Brian)
+# STREAMELEMENTS_VOICE=Brian
+
+## 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
+
+################################################################################
+### LOGGING
+################################################################################
+
+## 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.
+## Options: DEBUG, INFO, WARNING, ERROR, CRITICAL
+# LOG_LEVEL=INFO
+
+## LOG_FORMAT - The format in which to log messages to the console (and log files).
+## Options: simple, debug, structured_google_cloud
+# LOG_FORMAT=simple
+
+## LOG_FILE_FORMAT - Normally follows the LOG_FORMAT setting, but can be set separately.
+## Note: Log file output is disabled if LOG_FORMAT=structured_google_cloud.
+# LOG_FILE_FORMAT=simple
+
+## PLAIN_OUTPUT - Disables animated typing and the spinner in the console output. (Default: False)
+# PLAIN_OUTPUT=False
+
+
+################################################################################
+### Agent Protocol Server Settings
+################################################################################
+## AP_SERVER_PORT - Specifies what port the agent protocol server will listen on. (Default: 8000)
+# AP_SERVER_PORT=8000
+# # AP_SERVER_DB_URL - Specifies what connection url the agent protocol database will connect to (Default: Internal SQLite)
+# AP_SERVER_DB_URL=sqlite:///data/ap_server.db