Skip to content

OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.

docs: self-hosting pages match the reviewed CLI

Carl-Gerhard Lindesvärd2d7e2bfba367
diff --git a/apps/public/content/docs/self-hosting/changelog.mdx b/apps/public/content/docs/self-hosting/changelog.mdx
index a8fb74bac..4b7a6c9eb 100644
--- a/apps/public/content/docs/self-hosting/changelog.mdx
+++ b/apps/public/content/docs/self-hosting/changelog.mdx
@@ -14,7 +14,7 @@ curl -fsSL https://raw.githubusercontent.com/Openpanel-dev/openpanel/main/self-h
openpanel upgrade
```
-Before you do, stop sending events and let the old worker finish its queue. Events still waiting in Redis are not moved to Redpanda.
+Before 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;
diff --git a/apps/public/content/docs/self-hosting/deploy-docker-compose.mdx b/apps/public/content/docs/self-hosting/deploy-docker-compose.mdx
index d3f067d7a..ab0dbf09f 100644
--- a/apps/public/content/docs/self-hosting/deploy-docker-compose.mdx
+++ b/apps/public/content/docs/self-hosting/deploy-docker-compose.mdx
@@ -99,14 +99,9 @@ If you change the `.env` file, run `openpanel restart` for the changes to take e
The generated `.env` also contains commented-out blocks for optional features. Uncomment and fill them in to enable [social login with Google or GitHub](/docs/self-hosting/social-login) and the [Google Search Console integration](/docs/self-hosting/google-search-console).
-### Using Custom Docker Images
+### Docker Image Versions
-If you want to use specific image versions, edit the `docker-compose.yml` file and update the image tags:
-
-```yaml
-op-api:
- image: lindesvard/openpanel-api:2.0.0 # Specify version
-```
+Each CLI release is built for one OpenPanel image tag, and `openpanel upgrade` moves the `lindesvard/openpanel-*` images in your `docker-compose.yml` to it, including a version you pinned yourself. The compose changes an upgrade makes only work with the images they were released for. To stay on a version, don't run `upgrade`. Images from other registries are left alone.
### Scaling Workers
@@ -122,7 +117,7 @@ openpanel up
## Managing Your Deployment
-Run these from your install directory, or pass `--dir <path>`.
+Run these anywhere: the CLI finds your install (the current directory, `./self-hosting` in an old git clone, the last install it used, or a running OpenPanel stack) and prints which one it picked. Pass `--dir <path>` to choose explicitly.
### Basic Operations
@@ -171,7 +166,7 @@ Always backup your data before updating. The database migrations will run automa
openpanel reset
```
-Deletes this install's data volumes after you type the directory name to confirm. `docker-compose.yml` and `.env` are kept.
+Deletes this install's data volumes after you type the directory name to confirm. `docker-compose.yml`, `.env` and Caddy's HTTPS certificates are kept, so a fresh start does not re-request certificates.
### Backup and Restore
diff --git a/apps/public/content/docs/self-hosting/self-hosting.mdx b/apps/public/content/docs/self-hosting/self-hosting.mdx
index 71c48a27e..22f5e90c8 100644
--- a/apps/public/content/docs/self-hosting/self-hosting.mdx
+++ b/apps/public/content/docs/self-hosting/self-hosting.mdx
@@ -199,7 +199,7 @@ For a complete reference of all environment variables, see the [Environment Vari
## Helpful commands
-Run these from your install directory (`~/openpanel` by default), or pass `--dir <path>` from anywhere.
+Run these anywhere: the CLI finds your install (the current directory, `./self-hosting` in an old git clone, the last install it used, or a running OpenPanel stack) and prints which one it picked. Pass `--dir <path>` to choose explicitly.
### Basic Operations
@@ -235,7 +235,7 @@ openpanel reset # ⚠️ Deletes this install's data volumes
```
<Callout>
-`openpanel reset` deletes your databases and queues. It only touches this install's own volumes, and asks you to type the directory name before it does anything. Export first if you need the events.
+`openpanel reset` deletes your databases and queues. It only touches this install's own data volumes (your config and HTTPS certificates are kept), and asks you to type the directory name before it does anything. Export first if you need the events.
</Callout>
## Updating