Deploying Oxy using Docker containers
Prepare Your Workspace
config.yml
- Main configuration file.agent.yml
files).workflow.yml
files)Create a Docker Compose File
docker-compose.yml
file:your-openai-api-key
with your actual OpenAI API key. For production deployments, consider using Docker secrets or environment files to avoid storing sensitive data in your compose file.Start the Container
/app
. If you want to use /workspace
as your working directory (as in the example above), make sure to set working_dir: /workspace
in your Docker Compose file and mount your workspace to /workspace
.Your Oxy instance will be available at http://localhost:3000
once the container starts.~/.local/share/oxy/
on the host systemOXY_STATE_DIR
environment variable (typically to /data
) and mount a volume to that locationdocker-compose down -v
with caution as it will delete the volumes.Variable | Description | Example |
---|---|---|
OPENAI_API_KEY | Your OpenAI API key | sk-... |
OXY_STATE_DIR | Directory for Oxy state persistence | /data |
DATABASE_URL | Connection URL if using a database | postgres://... |
PORT | Override the default port | 8080 |