Get an API Key
Choose Your Database Backend
Pull the Docker Image
Run with Docker (Quick Start)
--network host
because Docker runs natively and can directly access the host network-p 8000:8000
and host.docker.internal
because Docker runs in a VM and needs port mappingRun with Docker Compose (Recommended)
docker-compose.yml
file:Verify Installation
Advanced Configuration
Variable | Description | Required | Example |
---|---|---|---|
CYBORGDB_API_KEY | Your CyborgDB API key | ✅ | cyborg_abc123... |
CYBORGDB_DB_TYPE | Database backend type | ✅ | postgres or redis |
CYBORGDB_CONNECTION_STRING | Database connection details | ✅ | See connection formats |
CYBORGDB_VERSION | Service version (optional) | ❌ | 0.11.1 |
PORT | Service port | ❌ | 8000 |
SSL_CERT_PATH | Path to SSL certificate file | ❌ | /etc/ssl/certs/server.crt |
SSL_KEY_PATH | Path to SSL private key file | ❌ | /etc/ssl/private/server.key |
Next Steps
Technical Specifications
continuumio/miniconda3:latest
Comparison with Python Service
Aspect | Python Service | Docker Service |
---|---|---|
Installation | pip install | docker run |
Dependencies | Managed by pip/conda | Bundled in container |
Resource Usage | Lower overhead | Higher overhead |
Environment Isolation | Python virtualenv | Container isolation |
Deployment Complexity | Simple Python deployment | Container orchestration |
Configuration | Environment variables/files | Environment variables |
Best For | Development, Python-heavy workflows | Production, cloud deployment |