aljaz/Auto-GPT
1
0
Fork 0
mirror of https://github.com/aljazceru/Auto-GPT.git synced 2025-12-17 14:04:27 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
bcdc8d46f5f0802e7aaef433a8b7d6fd6c4c413a
Auto-GPT/docs/content/AutoGPT/configuration/options.md
Bently bcdc8d46f5 Restructuring The Docs (#5441) 
* Adding More Info To The Docs

* Start of main page rebuild and adding new folders

* Starting to move the AutoGPT(agent) Docs to a subfolder and start setup forge's subfolder

* small fixes in links

* fix file name

* added the benchmakrs page

* added front-end page

* re-aranging the layout

* moved the config section to be under the AutoGPT folder

* fix image link

* moved "Share Logs" and "Testing" to be under the AutoGPT folder

* index.md: fix broken links on home page

* Index.md: Testing Something with the links

* index.md: Added the Benchmarks section

* small fix for Frontend

* Added a chat ai to the docs for testing as part of #5694

* index.md: sepetating the sections and making it easier to read

* index.md: Added discord Link

* index.md: Added better info to each section from @Yash-Ambekar

* index.md: trying to fix the layout

* Index.md: updating layout

* Move Docker Setup To Its Own File

* small fix

* seperating the installation setups to there own page for making things clear

* small fix in links

* fix links again

* change nav titles color to help make things clear

* fix css

* mv custom.css

* fix for css not working

* rm custom css as it didnt work

* fix img

* update image url

* update nav

* index.md: improving layout and wordings

* index.md: testing line breaks

* index.md: Fixed the line breaks

* setup/docker-setp.md: small fix

* Docker-setup.md update link to correct memory page

* docker-setup.md: added note about docker install being broken

* Docker-Setup.md: Updating the warning

* Docker-Setup.md : Test

* docker-setup.md: fix

* docker-setup.md: fix

* docker-setup.md final update to the warning

* Docker-Setup.md

* Updates to mkdocs.yml and docker-setup based on the feedback

* fix to docker-setup.md

* docker-setup.md fix

* introduction.md: fix

* Update docs/content/AutoGPT/Setups/Docker-setup.md

Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com>

* docker-setup.md update link

* Update docs/content/AutoGPT/Setups/Git-setup.md

Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com>

* Update docs/content/AutoGPT/Setups/Git-setup.md

Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com>

* nogit-setup.md: updated links

* Update docs/content/AutoGPT/Setups/Git-setup.md

Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com>

* Update docs/content/index.md

Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com>

* Update docs/content/index.md

Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com>

* Update docs/content/index.md

Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com>

* Update docs/content/index.md

Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com>

* setup.md: added extra info about the docker insall

* setup.md small changs to clean things up

* removed emojis from forge get-started.md

* get-started.md - small changes

* Update AutoGPT intro in index.md

---------

Co-authored-by: sohamtembhurne <sohamatembhurne@outlook.com>
Co-authored-by: Yash-Ambekar <yashambekar03@gmail.com>
Co-authored-by: Nicholas Tindle <nicholas.tindle@agpt.co>
Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com>
Co-authored-by: Reinier van der Leer <pwuts@agpt.co>
2023-11-15 18:54:29 +01:00

5.0 KiB
Raw Blame History

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 AutoGPT folder and name it .env.

Environment Variables

  • AI_SETTINGS_FILE: Location of the AI Settings file relative to the AutoGPT root directory. 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
  • AZURE_CONFIG_FILE: Location of the Azure Config file relative to the AutoGPT root directory. Default: azure.yaml
  • BROWSE_CHUNK_MAX_LENGTH: When browsing website, define the length of chunks to summarize. Default: 3000
  • BROWSE_SPACY_LANGUAGE_MODEL: spaCy language model 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. Optional.
  • GITHUB_USERNAME: GitHub Username. Optional.
  • GOOGLE_API_KEY: Google API key. Optional.
  • GOOGLE_CUSTOM_SEARCH_ENGINE_ID: Google custom search engine ID. Optional.
  • HEADLESS_BROWSER: Use a headless browser while AutoGPT uses a web browser. Setting to False will allow you to see AutoGPT 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.
  • OPENAI_ORGANIZATION: Organization ID in OpenAI. Optional.
  • PLAIN_OUTPUT: Plain output, which disables the spinner. Default: False
  • PLUGINS_CONFIG_FILE: Path of the Plugins Config file relative to the AutoGPT root directory. Default: plugins_config.yaml
  • PROMPT_SETTINGS_FILE: Location of the Prompt Settings file relative to the AutoGPT root directory. 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 AutoGPT. 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 AutoGPT. 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