OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.
# documentation: https://openpanel.dev/docs
# slogan: Open source alternative to Mixpanel and Plausible for product analytics
# tags: analytics, insights, privacy, mixpanel, plausible, google, alternative
# logo: svgs/openpanel.svg
# port: 3000
services:
opdb:
image: postgres:16-alpine
restart: always
volumes:
- opdb-data:/var/lib/postgresql/data
environment:
- POSTGRES_DB=${OPENPANEL_POSTGRES_DB:-openpanel-db}
- POSTGRES_USER=${SERVICE_USER_POSTGRES}
- POSTGRES_PASSWORD=${SERVICE_PASSWORD_POSTGRES}
healthcheck:
test: [CMD-SHELL, "pg_isready -U $${POSTGRES_USER} -d $${POSTGRES_DB}"]
interval: 10s
timeout: 5s
retries: 5
opkv:
image: redis:7.4-alpine
restart: always
volumes:
- opkv-data:/data
command: redis-server --requirepass ${SERVICE_PASSWORD_REDIS} --maxmemory-policy noeviction
healthcheck:
test: [CMD, redis-cli, -a, "${SERVICE_PASSWORD_REDIS}", ping]
interval: 10s
timeout: 5s
retries: 5
opch:
image: clickhouse/clickhouse-server:24.3.2-alpine
restart: always
volumes:
- opch-data:/var/lib/clickhouse
- type: bind
source: ./clickhouse-config.xml
target: /etc/clickhouse-server/config.d/op-config.xml
read_only: true
content: |
<clickhouse>
<logger>
<level>warning</level>
<console>true</console>
<!-- Disable file logging entirely; rely on docker's log driver for stdout capture.
<console>true</console> alone does not disable inherited <log>/<errorlog> file paths,
which can spin-loop on inode loss. See ClickHouse/clickhouse-docs#4255. -->
<log remove="remove" />
<errorlog remove="remove" />
</logger>
<keep_alive_timeout>10</keep_alive_timeout>
<!-- Stop all the unnecessary logging -->
<query_thread_log remove="remove"/>
<query_log remove="remove"/>
<text_log remove="remove"/>
<trace_log remove="remove"/>
<metric_log remove="remove"/>
<asynchronous_metric_log remove="remove"/>
<session_log remove="remove"/>
<part_log remove="remove"/>
<listen_host>0.0.0.0</listen_host>
<interserver_listen_host>0.0.0.0</interserver_listen_host>
<interserver_http_host>opch</interserver_http_host>
<!-- Disable cgroup memory observer -->
<cgroups_memory_usage_observer_wait_time>0</cgroups_memory_usage_observer_wait_time>
<!-- Not used anymore, but kept for backwards compatibility -->
<macros>
<shard>1</shard>
<replica>replica1</replica>
<cluster>openpanel_cluster</cluster>
</macros>
</clickhouse>
- type: bind
source: ./clickhouse-user-config.xml
target: /etc/clickhouse-server/users.d/op-user-config.xml
read_only: true
content: |
<clickhouse>
<profiles>
<default>
<log_queries>0</log_queries>
<log_query_threads>0</log_query_threads>
</default>
</profiles>
</clickhouse>
- type: bind
source: ./init-db.sh
target: /docker-entrypoint-initdb.d/init-db.sh
content: |
#!/bin/sh
set -e
clickhouse client -n <<-EOSQL
CREATE DATABASE IF NOT EXISTS openpanel;
EOSQL
healthcheck:
test: [CMD-SHELL, 'clickhouse-client --query "SELECT 1"']
interval: 10s
timeout: 5s
retries: 5
ulimits:
nofile:
soft: 262144
hard: 262144
opapi:
image: lindesvard/openpanel-api:latest
restart: always
# Same contract as docker-compose.template.yml's op-api: no second package
# manager exists in this image (P13 / ADR-014), migrations run in this
# container's start command, with the Prisma CLI the image ships. See the
# long note there.
command: >
sh -c "
echo 'Waiting for PostgreSQL to be ready...'
while ! nc -z opdb 5432; do
sleep 1
done
echo 'PostgreSQL is ready'
echo 'Waiting for ClickHouse to be ready...'
while ! nc -z opch 8123; do
sleep 1
done
echo 'ClickHouse is ready'
echo 'Running migrations...'
cd /app/packages/db && prisma migrate deploy
cd /app/apps/api && bun run start
"
depends_on:
opdb:
condition: service_healthy
opch:
condition: service_healthy
opkv:
condition: service_healthy
environment:
# Common
- NODE_ENV=production
- SELF_HOSTED=true
- AUTOMATIC_MIGRATIONS=true
# URLs
- DATABASE_URL=postgres://${SERVICE_USER_POSTGRES}:${SERVICE_PASSWORD_POSTGRES}@opdb:5432/${OPENPANEL_POSTGRES_DB:-openpanel-db}?schema=public
- DATABASE_URL_DIRECT=postgres://${SERVICE_USER_POSTGRES}:${SERVICE_PASSWORD_POSTGRES}@opdb:5432/${OPENPANEL_POSTGRES_DB:-openpanel-db}?schema=public
- REDIS_URL=redis://default:${SERVICE_PASSWORD_REDIS}@opkv:6379
- CLICKHOUSE_URL=${OPENPANEL_CLICKHOUSE_URL:-http://opch:8123/openpanel}
- SERVICE_FQDN_OPAPI=/api
# Set coolify FQDN domain
- API_URL=$SERVICE_FQDN_OPAPI
- DASHBOARD_URL=$SERVICE_FQDN_OPDASHBOARD
# Others
- COOKIE_SECRET=${SERVICE_BASE64_COOKIESECRET}
- ENCRYPTION_KEY=${SERVICE_HEX_64_ENCRYPTIONKEY}
- ALLOW_REGISTRATION=${OPENPANEL_ALLOW_REGISTRATION:-false}
- ALLOW_INVITATION=${OPENPANEL_ALLOW_INVITATION:-true}
- EMAIL_SENDER=${OPENPANEL_EMAIL_SENDER}
- RESEND_API_KEY=${RESEND_API_KEY}
# Optional: social login (https://openpanel.dev/docs/self-hosting/social-login)
- GOOGLE_CLIENT_ID=${OPENPANEL_GOOGLE_CLIENT_ID}
- GOOGLE_CLIENT_SECRET=${OPENPANEL_GOOGLE_CLIENT_SECRET}
- GOOGLE_REDIRECT_URI=${OPENPANEL_GOOGLE_REDIRECT_URI}
- GITHUB_CLIENT_ID=${OPENPANEL_GITHUB_CLIENT_ID}
- GITHUB_CLIENT_SECRET=${OPENPANEL_GITHUB_CLIENT_SECRET}
- GITHUB_REDIRECT_URI=${OPENPANEL_GITHUB_REDIRECT_URI}
# Optional: Google Search Console (https://openpanel.dev/docs/self-hosting/google-search-console)
- GSC_GOOGLE_REDIRECT_URI=${OPENPANEL_GSC_GOOGLE_REDIRECT_URI}
healthcheck:
test: ["CMD-SHELL", "curl -f http://localhost:3000/healthcheck || exit 1"]
interval: 10s
timeout: 5s
retries: 5
opdashboard:
image: lindesvard/openpanel-dashboard:latest
restart: always
depends_on:
opapi:
condition: service_healthy
environment:
# Common
- NODE_ENV=production
- SELF_HOSTED=true
# URLs
- DATABASE_URL=postgres://${SERVICE_USER_POSTGRES}:${SERVICE_PASSWORD_POSTGRES}@opdb:5432/${OPENPANEL_POSTGRES_DB:-openpanel-db}?schema=public
- REDIS_URL=redis://default:${SERVICE_PASSWORD_REDIS}@opkv:6379
- CLICKHOUSE_URL=${OPENPANEL_CLICKHOUSE_URL:-http://opch:8123/openpanel}
- SERVICE_FQDN_OPDASHBOARD
# Set coolify FQDN domain
- API_URL=$SERVICE_FQDN_OPAPI
- DASHBOARD_URL=$SERVICE_FQDN_OPDASHBOARD
healthcheck:
test:
["CMD-SHELL", "curl -f http://localhost:3000/api/healthcheck || exit 1"]
interval: 10s
timeout: 5s
retries: 5
# ONE image, two roles — see the note on op-worker in
# docker-compose.template.yml. ROLE=worker turns the api image into the
# queue/scheduler/Kafka half.
opworker:
image: lindesvard/openpanel-api:latest
restart: always
depends_on:
opapi:
condition: service_healthy
environment:
- ROLE=worker
# FQDN
- SERVICE_FQDN_OPBULLBOARD
# Common
- NODE_ENV=production
- SELF_HOSTED=true
- AUTOMATIC_MIGRATIONS=true
# URLs
- DATABASE_URL=postgres://${SERVICE_USER_POSTGRES}:${SERVICE_PASSWORD_POSTGRES}@opdb:5432/${OPENPANEL_POSTGRES_DB:-openpanel-db}?schema=public
- DATABASE_URL_DIRECT=postgres://${SERVICE_USER_POSTGRES}:${SERVICE_PASSWORD_POSTGRES}@opdb:5432/${OPENPANEL_POSTGRES_DB:-openpanel-db}?schema=public
- REDIS_URL=redis://default:${SERVICE_PASSWORD_REDIS}@opkv:6379
- CLICKHOUSE_URL=${OPENPANEL_CLICKHOUSE_URL:-http://opch:8123/openpanel}
# Set coolify FQDN domain
- API_URL=$SERVICE_FQDN_OPAPI
# Must match the API's key: the worker decrypts GSC tokens during sync
- ENCRYPTION_KEY=${SERVICE_HEX_64_ENCRYPTIONKEY}
# Must match the API's secret: unsubscribe links in worker emails are
# verified by the API, and signing them needs a real secret
- COOKIE_SECRET=${SERVICE_BASE64_COOKIESECRET}
# Operator credentials for the queue dashboard (HTTP Basic, on top of
# the dashboard session guard)
- ADMIN_USERNAME=${SERVICE_USER_ADMIN}
- ADMIN_PASSWORD=${SERVICE_PASSWORD_ADMIN}
# Optional: Google Search Console sync needs the Google OAuth client
- GOOGLE_CLIENT_ID=${OPENPANEL_GOOGLE_CLIENT_ID}
- GOOGLE_CLIENT_SECRET=${OPENPANEL_GOOGLE_CLIENT_SECRET}
healthcheck:
test: ["CMD-SHELL", "curl -f http://localhost:3000/healthz/ready || exit 1"]
interval: 10s
timeout: 5s
retries: 5