diff options
Diffstat (limited to 'autogpts/autogpt/.env.template')
| -rw-r--r-- | autogpts/autogpt/.env.template | 113 |
1 files changed, 67 insertions, 46 deletions
diff --git a/autogpts/autogpt/.env.template b/autogpts/autogpt/.env.template index 0ab9a4e55..9ec564a5d 100644 --- a/autogpts/autogpt/.env.template +++ b/autogpts/autogpt/.env.template @@ -1,5 +1,3 @@ -# For further descriptions of these settings see docs/configuration/options.md or go to docs.agpt.co - ################################################################################ ### AutoGPT - GENERAL SETTINGS ################################################################################ @@ -10,9 +8,32 @@ 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) +### 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" @@ -25,26 +46,12 @@ OPENAI_API_KEY=your-openai-api-key ## 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 -## 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_FUNCTIONS - Enables OpenAI functions: https://platform.openai.com/docs/guides/gpt/function-calling -## WARNING: this feature is only supported by OpenAI's newest models. Until these models become the default on 27 June, add a '-0613' suffix to the model of your choosing. -# OPENAI_FUNCTIONS=False - ## AUTHORISE COMMAND KEY - Key to authorise commands # AUTHORISE_COMMAND_KEY=y ## EXIT_KEY - Key to exit AutoGPT # 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 ################################################################################ @@ -52,15 +59,28 @@ OPENAI_API_KEY=your-openai-api-key ## 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 AutoGPT root directory. (Default: azure.yaml) +## 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 @@ -91,32 +111,6 @@ OPENAI_API_KEY=your-openai-api-key # 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 ################################################################################ @@ -191,13 +185,12 @@ OPENAI_API_KEY=your-openai-api-key ################################################################################ ## TEXT_TO_SPEECH_PROVIDER - Which Text to Speech provider to use (Default: gtts) +## Options: gtts, streamelements, elevenlabs, macos # 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= @@ -210,3 +203,31 @@ OPENAI_API_KEY=your-openai-api-key ## 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 |