# Quick Start with Docker Compose
To quickly get started with Hayhooks, we provide a ready-to-use Docker Compose 🐳 setup with pre-configured integration with [Open WebUI](https://openwebui.com/).
It's available in the [Hayhooks + Open WebUI Docker Compose repository](https://github.com/deepset-ai/hayhooks-open-webui-docker-compose).
## Setup Instructions
### 1. Clone the Repository
```bash
git clone https://github.com/deepset-ai/hayhooks-open-webui-docker-compose.git
cd hayhooks-open-webui-docker-compose
```
### 2. Configure Environment Variables
Copy the example environment file:
```bash
cp .env.example .env
```
Edit the `.env` file to configure your settings:
```ini
# Hayhooks Configuration
HAYHOOKS_HOST=0.0.0.0
HAYHOOKS_PORT=1416
HAYHOOKS_MCP_PORT=1417
HAYHOOKS_PIPELINES_DIR=/app/pipelines
# OpenWebUI Configuration
OPENWEBUI_PORT=3000
```
### 3. Start the Services
```bash
docker-compose up -d
```
This will start:
- Hayhooks server on port 1416
- Hayhooks MCP server on port 1417
- Open WebUI on port 3000
### 4. Access the Services
- **Hayhooks API**: <http://localhost:1416>
- **Open WebUI**: <http://localhost:3000>
- **Hayhooks API Documentation**: <http://localhost:1416/docs>
### 5. Deploy Example Pipelines
Install Hayhooks locally to use the CLI:
```bash
pip install hayhooks
```
Then deploy example pipelines:
```bash
# Deploy a sample pipeline
hayhooks pipeline deploy-files -n chat_with_website examples/pipeline_wrappers/chat_with_website_streaming
```
!!! tip "Alternative: Deploy via API"
You can also deploy pipelines using the HTTP API endpoints: `POST /deploy_files` (PipelineWrapper files) or `POST /deploy-yaml` (YAML pipeline definition). See the [API Reference](../reference/api-reference.md#pipeline-management) for details.
## Configuration Options
### Environment Variables
The following environment variables can be configured in `.env`:
| Variable | Description | Default |
|----------|-------------|---------|
| `HAYHOOKS_HOST` | Host to bind to | `0.0.0.0` |
| `HAYHOOKS_PORT` | Port for Hayhooks API | `1416` |
| `HAYHOOKS_MCP_PORT` | Port for Hayhooks MCP server | `1417` |
| `HAYHOOKS_PIPELINES_DIR` | Directory for pipeline definitions | `/app/pipelines` |
| `OPENWEBUI_PORT` | Port for Open WebUI | `3000` |
### Volume Mounts
The Docker Compose setup includes the following volume mounts:
- **Pipeline Directory**: `/app/pipelines` – Directory mounted inside the Hayhooks container where your pipeline wrappers or YAML files live. Hayhooks auto-deploys anything it finds here at startup.
## Integrating with Open WebUI
The Docker Compose setup comes pre-configured to integrate Hayhooks with Open WebUI:
### 1. Configure Open WebUI
1. Access Open WebUI at <http://localhost:3000>
2. Go to **Settings → Connections**
3. Add a new connection with:
- **API Base URL**: `http://hayhooks:1416/v1`
- **API Key**: `any-value` (not used by Hayhooks)
### 2. Deploy a Pipeline
Deploy a pipeline that supports chat completion:
```bash
hayhooks pipeline deploy-files -n chat_agent examples/pipeline_wrappers/open_webui_agent_events
```
Alternatively, use the [API endpoints](../reference/api-reference.md#pipeline-management) (`POST /deploy_files` or `POST /deploy-yaml`).
### 3. Test the Integration
1. In Open WebUI, select the Hayhooks backend
2. Start a conversation with your deployed pipeline
3. The pipeline will respond through the Open WebUI interface
## Troubleshooting
### Common Issues
1. **Port Conflicts**: Ensure ports 1416, 1417, and 3000 are available
2. **Permission Issues**: Make sure Docker has proper permissions
3. **Network Issues**: Check that containers can communicate with each other
### Logs
Check logs for troubleshooting:
```bash
# Hayhooks logs
docker-compose logs -f hayhooks
# Open WebUI logs
docker-compose logs -f openwebui
```
### Cleanup
To stop and remove all containers:
```bash
docker-compose down -v
```
## Next Steps
- [Configuration](../getting-started/configuration.md) - Learn about advanced configuration
- [Examples](../examples/overview.md) - Explore more examples
- [Open WebUI Integration](../features/openwebui-integration.md) - Deep dive into Open WebUI integration
