Quick Start
This guide explains how to set up Agenta on your local machine, either using the default port 80 or a custom port.
Prerequisites
- Docker installed on your machine (Download Docker)
Quick Setup (Port 80)
- Clone Agenta:
git clone https://github.com/Agenta-AI/agenta && cd agenta
-
Copy
hosting/docker-compose/oss/.env.oss.gh.example
tohosting/docker-compose/oss/.env.oss.gh
and edit the configuration. -
Start Agenta services:
docker compose -f hosting/docker-compose/oss/docker-compose.gh.yml --env-file hosting/docker-compose/oss/.env.oss.gh --profile with-web up -d
- Access Agenta at
http://localhost
.
Using a Custom Port
To use a different port (e.g., 90):
Change the following variables in the environment file /hosting/docker-compose/oss/.env.oss.gh
then restart the services:
TRAEFIK_PORT=90
AGENTA_SERVICES_URL=http://localhost:90/services
AGENTA_API_URL=http://localhost:90/api
AGENTA_WEB_URL=http://localhost:90
Upgrading to the Latest Version of Agenta
Updating your local Agenta installation to the latest version, requires pulling the latest version with --pull always
and running migrations if any.
- Pull the latest version:
docker compose -f hosting/docker-compose/oss/docker-compose.gh.yml --env-file hosting/docker-compose/oss/.env.oss.gh --profile with-web up -d --pull always
- Run migrations if needed:
docker exec -e PYTHONPATH=/app -w /app/oss/databases/postgres/migrations/core agenta-oss-gh-api-1 alembic -c alembic.ini upgrade head
Consult the upgrading guide for more details.
Troubleshooting
If Agenta doesn't start properly, check these common issues:
- Port conflicts: Verify if another application is using your chosen port.
- Container status: Run
docker ps
to check if all Agenta containers are running - Logs: Examine container logs with:
docker logs agenta-oss-gh-web
docker logs agenta-oss-gh-api - SDK connectivity issues: If you're using the Agenta SDK from outside Docker to connect to your localhost Agenta instance and experiencing connection failures, ensure the
DOCKER_NETWORK_MODE
environment variable is unset (this is the default behavior).
To set up a development environment with features like hot-reloading, refer to our Development Guide.
Need help? Either:
- Create a GitHub issue
- Join our Slack community for quick support