Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Chore] Add LLM provider keys to .env in readme and docs #2470

Merged
merged 4 commits into from
Feb 10, 2025
Merged

[Chore] Add LLM provider keys to .env in readme and docs #2470

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c467793
fix readme
jp-agenta Feb 10, 2025
552382d
add provider keys to docs
jp-agenta Feb 10, 2025
0d7dd91
Update README.md
mmabrouk Feb 10, 2025
d3cc192
Update host-locally.mdx
mmabrouk Feb 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion agenta-cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,8 @@ The easiest way to get started is through Agenta Cloud. It is free to signup, an
```bash
mkdir agenta && cd agenta
curl -L https://raw.githubusercontent.com/agenta-ai/agenta/main/docker-compose.gh.yml -o docker-compose.gh.yml
docker compose -f docker-compose.gh.yml up -d
echo "OPENAI_API_KEY=sk-xxx" > .env
docker compose -f docker-compose.gh.yml --env-file .env up -d --pull always
```

#### Deployment Options
Expand Down
16 changes: 13 additions & 3 deletions docs/docs/self-host/host-locally.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,12 @@ To deploy Agenta on port 80, run these commands:
```bash
mkdir agenta && cd agenta
curl -L https://raw.githubusercontent.com/agenta-ai/agenta/main/docker-compose.gh.yml -o docker-compose.gh.yml
docker compose -f docker-compose.gh.yml up -d
echo "OPENAI_API_KEY=sk-xxx" > .env
docker compose -f docker-compose.gh.yml --env-file .env up -d --pull always
```
:::info
Include in the `.env` file all the LLM provider keys that you would like the playground to have access to.
:::

Once complete, access Agenta at `http://localhost`.

Expand All @@ -28,7 +32,10 @@ To run Agenta on a different port, you'll need to re-build the frontend image. H

1. Build and run with your chosen port:
```bash
AGENTA_PORT=8081 docker compose -f docker-compose.gh.yml build --no-cache agenta-web && AGENTA_PORT=8081 docker compose -f docker-compose.gh.yml up -d
echo "OPENAI_API_KEY=sk-xxx" > .env
docker compose -f docker-compose.gh.yml pull
AGENTA_PORT=8081 docker compose -f docker-compose.gh.yml build --no-cache agenta-web
AGENTA_PORT=8081 docker compose -f docker-compose.gh.yml --env-file .env up -d
```

Access Agenta at `http://localhost:8081` (or your chosen port).
Expand All @@ -41,8 +48,11 @@ To update your local installation:
# Download the latest compose file
curl -L https://raw.githubusercontent.com/agenta-ai/agenta/main/docker-compose.gh.yml -o docker-compose.gh.yml

# Updating your LLM provider keys
echo "OPENAI_API_KEY=sk-xxx" > .env

# Update and restart containers
docker compose -f docker-compose.gh.yml up -d --pull always
docker compose -f docker-compose.gh.yml --env-file .env up -d --pull always
```

The system will automatically handle database migrations. If you encounter migration issues, consult the [migration guide](/self-host/migration/applying-schema-migration).
Expand Down
Loading