Skip to content

Commit

Permalink
Update Quick Start.md
Browse files Browse the repository at this point in the history
Signed-off-by: Josh XT <[email protected]>
  • Loading branch information
Josh-XT authored Jul 13, 2023
1 parent e6d60fb commit b2af374
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/1-Getting started/Quick Start.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ cd AGiXT
### Environment Setup
During the installation, you will be prompted to enter some settings unless you already have your `.env` file set up. If you do not have your `.env` file set up, you can use the following as a guide:

![image](https://github.com/Josh-XT/AGiXT/assets/102809327/c8ae9698-f1e0-44b8-9fb2-85cb66b684b7)

- `AGIXT_API_KEY` is the API key to use for the AGiXT API. This is empty by default, if you would like to set it, change it in the env file. The header format for requests will be `Authorization: Bearer {your_api_key}` for any requests to your AGiXT server or you can pass the `api_key` to the AGiXT SDK.

Expand All @@ -45,6 +46,8 @@ During the installation, you will be prompted to enter some settings unless you
### Install Options
You will be prompted to choose an install option. The options are as follows:

![image](https://github.com/Josh-XT/AGiXT/assets/102809327/dd83bda7-f592-4bd8-a377-e2eb5e7e5dcb)

1. **Run AGiXT with Docker (Recommended)**
- This option will run [AGiXT](https://github.com/Josh-XT/AGiXT) and the [AGiXT Streamlit Web UI](https://github.com/AGiXT/streamlit) in Docker containers. This is the recommended option for most users.
2. **Run AGiXT Locally (Developers Only - Not Recommended or Supported)**
Expand All @@ -70,4 +73,4 @@ Then follow the prompts to run or update AGiXT either locally or with Docker. We
- Access the web interface at http://localhost:8501
- Access the AGiXT API documentation at http://localhost:7437

If you're running with the option `Run AGiXT and Text Generation Web UI with Docker (NVIDIA Only)`, you can access the Text Generation Web UI at http://localhost:7860/?__theme=dark to download and and configure your models. The `AI_PROVIDER_URI` will be `http://text-generation-webui:5000` for your AGiXT agents.
If you're running with the option `Run AGiXT and Text Generation Web UI with Docker (NVIDIA Only)`, you can access the Text Generation Web UI at http://localhost:7860/?__theme=dark to download and and configure your models. The `AI_PROVIDER_URI` will be `http://text-generation-webui:5000` for your AGiXT agents.

0 comments on commit b2af374

Please sign in to comment.