Overview
Self-hosting Aden gives you complete control over your deployment, data, and infrastructure. This guide walks you through setting up Aden using Docker Compose.Prerequisites
Docker
Docker Engine 20.10+ and Docker Compose v2+
Git
Git for cloning the repository
Installation
Step 1: Clone the Repository
Get a copy of the latest Aden repository:Step 2: Run Docker Compose
Start all services using Docker Compose:- Aden API server
- Database (PostgreSQL)
- Cache layer (Redis)
- Web dashboard
Step 3: Access the Dashboard
Once the services are running, access the Aden dashboard at:Configuration
The defaultconfig.yaml file comes with sensible defaults for quick testing. You only need to modify it for production deployments or custom requirements.
Key Configuration Options
If you need to customize your deployment, edit theconfig.yaml file in the repository:
Server Ports (if ports 3000/4000 are already in use):
Advanced Docker Compose Customization
For advanced configurations, you can also modify thedocker-compose.yml file to:
- Change port mappings
- Add volume mounts for persistence
- Configure resource limits
- Set up external networks
Connecting Your SDKs
After deployment, configure your SDKs to point to your self-hosted instance:Use
http://localhost:4000 as the server URL for self-hosted instances.- TypeScript
- Python
Updating
To update your self-hosted Aden instance:Troubleshooting
Services Won’t Start
Check Docker logs for specific errors:Github Documentation
Visit the github Beeline documentation for more information.Need Help?
Book a Discovery Call
Get expert help with your self-hosted deployment.