Skip to main content

Docker Installation

Docker provides a platform-independent way to run Hyppot without any development environment setup. This approach is perfect for quick deployments, demos, or when you want to integrate Hyppot with non-.NET applications.

Prerequisites​

  • Docker installed on your machine
  • Basic familiarity with Docker commands

Quick Setup​

Pull and run the latest Hyppot Docker image:

docker run -d \
  --name hyppot \
  -p 8080:8080 \
  -e HYPPOT_DB_PROVIDER="sqlite" \
  -e HYPPOT_CONNECTION_STRING="Data Source=/app/storage/hyppot.db" \
  -v hyppot_data:/app/storage \
  ghcr.io/hyppot/hyppot-server:latest

Access Hyppot at: http://localhost:8080/hyppot/panel

Configuration​

Using Docker Compose? See Docker Compose examples.

Admin User Setup​

On first access, you'll be prompted to create an admin account through the web interface. Alternatively, you can pre-configure admin credentials by adding them as environment variables for non-interactive setup:

docker run -d \
  --name hyppot \
  -p 8080:8080 \
  -e ADMIN_EMAIL="[email protected]" \
  -e ADMIN_PASSWORD="YourSecurePassword123!" \
  -e HYPPOT_DB_PROVIDER="sqlite" \
  -e HYPPOT_CONNECTION_STRING="Data Source=/app/storage/hyppot.db" \
  -v hyppot_data:/app/storage \
  ghcr.io/hyppot/hyppot-server:latest

Database Configuration​

You can use one of three available database engines for Hyppot storage: Choose your database provider:

SQLite​

SQLite is small, lightweight in-process database engine, perfect for single-instance deployments:

-e HYPPOT_DB_PROVIDER="sqlite"
-e HYPPOT_CONNECTION_STRING="Data Source=/app/storage/hyppot.db"

PostgreSQL​

-e HYPPOT_DB_PROVIDER="postgresql"
-e HYPPOT_CONNECTION_STRING="Host=your-postgres-host;Database=hyppotdb;Username=postgres;Password=your-password;"

SQL Server​

-e HYPPOT_DB_PROVIDER="sqlserver"
-e HYPPOT_CONNECTION_STRING="Server=your-server;Database=HyppotDb;User Id=sa;Password=YourPassword;TrustServerCertificate=true;"

Storage and Logs​

  • Application logs: /app/storage/logs/ inside the container
  • Database files: /app/storage/ (for SQLite)
  • License file: For production installations you need a valid license file. To install license, you can upload it to /app/storage/hyppot.license on container volume or using the administrative interface.

Production Considerations​

Important: The examples above show basic configuration options for demonstration purposes. For production deployments, implement proper security measures including strong passwords, secret management (Docker secrets or external secret stores), regular backups, monitoring, and access controls. Never use default passwords in production environments!

  • Load Balancing: To avoid migration conflicts, start instances sequentially
  • Updates: Pull latest images and restart containers to update

Next Steps​

After installation: