Changelog for self-hosting
This is a list of changes that have been made to the self-hosting setup.
3.0.0
Redpanda is now a required part of the stack, and the separate worker image is gone.
Upgrade with the CLI, which makes all of the changes below for you after asking:
curl -fsSL https://raw.githubusercontent.com/Openpanel-dev/openpanel/main/self-hosting/install.sh | sh
openpanel upgradeBefore you do, stop sending events and let the old worker finish its queue. Events still waiting in Redis are not moved to Redpanda. upgrade asks you to confirm this; in scripts, pass --queue-drained (--yes does not answer it).
TLDR;
- Images move from
:2to:3(lindesvard/openpanel-api:3,lindesvard/openpanel-dashboard:3) - New
op-rp(Redpanda) service, itsop-rp-datavolume andredpanda/bootstrap.yaml;op-apiandop-workerwait for it op-workernow runs theopenpanel-apiimage withROLE=workerand a/healthz/readyhealthcheck;openpanel-workeris no longer builtop-apimigrates withprismaandscripts/migrate-code.tsunder bun- New required env:
KAFKA_BROKERS=op-rp:9092,KAFKA_EVENTS_TOPIC_PARTITIONS,ENCRYPTION_KEY(64 hex characters) andCOOKIE_SECRET ADMIN_USERNAMEandADMIN_PASSWORDmust be set togetherENABLED_QUEUES:events_kafkais nowevents, andmiscis removed- Removed, no longer read:
WORKER_PORT,EVENT_JOB_CONCURRENCY,EVENTS_GROUP_QUEUES_SHARDS,EVENT_BLOCKING_TIMEOUT_SEC,ORDERING_DELAY_MS,AUTO_BATCH_SIZE,AUTO_BATCH_MAX_WAIT_MS,SHUTDOWN_GRACE_PERIOD_MS - Caddy:
worker.<domain>redirects/to/bullboard/ - The
./setup,./start,./updateand friends are replaced by theopenpanelCLI.openpanel doctorchecks an existing install andopenpanel doctor --fixrepairs it
2.0.0
We have released the first stable version of OpenPanel v2. This is a big one!
Read more about it in our migration guide.
TLDR;
- Clickhouse upgraded from 24.3.2-alpine to 25.10.2.65
- Add
CLICKHOUSE_SKIP_USER_SETUP=1to op-ch service NEXT_PUBLIC_DASHBOARD_URL->DASHBOARD_URLNEXT_PUBLIC_API_URL->API_URLNEXT_PUBLIC_SELF_HOSTED->SELF_HOSTED
1.2.0
We have renamed SELF_HOSTED to NEXT_PUBLIC_SELF_HOSTED. It's important to rename this env before your upgrade to this version.
1.1.1
Packed with new features since our first stable release.
1.0.0 (stable)
OpenPanel self-hosting is now in a stable state and should not be any breaking changes in the future.
If you are upgrading from a previous version, you should keep an eye on the logs since it well tell you if you need to take any actions. Its not mandatory but its recommended since it might bite you in the *ss later.
New environment variables.
If you upgrading from a previous version, you'll need to edit your .env file if you want to use these new variables.
ALLOW_REGISTRATION- If set tofalsenew users will not be able to register (only the first user can register).ALLOW_INVITATION- If set tofalsenew users will not be able to be invited.RESEND_API_KEY- If set, we'll use Resend to send e-mails.EMAIL_SENDER- The e-mail address that will be used to send e-mails.
Removed Clickhouse Keeper
In 0.0.6 we introduced a cluster mode for Clickhouse. This was a mistake and we have removed it.
Remove op-zk from services and volumes
services:
op-zk:
image: clickhouse/clickhouse-server:24.3.2-alpine
volumes:
- op-zk-data:/var/lib/clickhouse
- ./clickhouse/clickhouse-keeper-config.xml:/etc/clickhouse-server/config.xml
command: [ 'clickhouse-keeper', '--config-file', '/etc/clickhouse-server/config.xml' ]
restart: always
ulimits:
nofile:
soft: 262144
hard: 262144
volumes:
op-zk-data:
driver: local0.0.6
Removed Clerk.com and added self-hosted authentication. For more info read our migrating from clerk
Latest Docker Images
Get access to OpenPanel's latest private Docker images with bleeding-edge features built on every commit.
Beta to V1
We are happy to announce the release of `v1` of the Openpanel SDK. This release includes a lot of improvements and changes to the SDK. This guide will help you migrate from the `beta` version to the `v1` version.