Files
Auto-GPT/docs/content/AutoGPT/Setups/nogit-setup.md
Kiran d27a5b7f49 Fix typo and broken link in no-git setup (#6324)
* Fix typo in heading

* Update link to system requirements

---------

Co-authored-by: Reinier van der Leer <github@pwuts.nl>
2023-11-21 13:24:20 +01:00

3.5 KiB

Setting Up without Git/Docker

!!! warning We recommend to use Git or Docker, to make updating easier. Also note that some features such as Python execution will only work inside docker for security reasons.

  1. Download Source code (zip) from the latest stable release
  2. Extract the zip-file into a folder

Configuration

  1. Find the file named .env.template in the main Auto-GPT folder. This file may be hidden by default in some operating systems due to the dot prefix. To reveal hidden files, follow the instructions for your specific operating system: Windows, macOS.

  2. Create a copy of .env.template and call it .env; if you're already in a command prompt/terminal window: cp .env.template .env.

  3. Open the .env file in a text editor.

  4. Find the line that says OPENAI_API_KEY=.

  5. After the =, enter your unique OpenAI API Key without any quotes or spaces.

  6. Enter any other API keys or tokens for services you would like to use.

    !!! note To activate and adjust a setting, remove the # prefix.

  7. Save and close the .env file.

!!! info "Using a GPT Azure-instance" If you want to use GPT on an Azure instance, set USE_AZURE to True and make an Azure configuration file:

- Rename `azure.yaml.template` to `azure.yaml` and provide the relevant `azure_api_base`, `azure_api_version` and all the deployment IDs for the relevant models in the `azure_model_map` section:
    - `fast_llm_deployment_id`: your gpt-3.5-turbo or gpt-4 deployment ID
    - `smart_llm_deployment_id`: your gpt-4 deployment ID
    - `embedding_model_deployment_id`: your text-embedding-ada-002 v2 deployment ID

Example:

```yaml
# Please specify all of these values as double-quoted strings
# Replace string in angled brackets (<>) to your own deployment Name
azure_model_map:
    fast_llm_deployment_id: "<auto-gpt-deployment>"
    ...
```

Details can be found in the [openai-python docs], and in the [Azure OpenAI docs] for the embedding model.
If you're on Windows you may need to install an [MSVC library](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170).

Start AutoGPT In A Virtual Environment

First we need to create a virtual environment to run in.

pip3 install poetry
python -m venv .venv
source .venv/bin/activate
poetry install

!!! warning Due to security reasons, certain features (like Python execution) will by default be disabled when running without docker. So, even if you want to run the program outside a docker container, you currently still need docker to actually run scripts.

Simply run the startup script in your terminal. This will install any necessary Python packages and launch AutoGPT.

  • On Linux/MacOS:

    ./run.sh
    
  • On Windows:

    .\run.bat
    

If this gives errors, make sure you have a compatible Python version installed. See also the requirements.