feat(docker): publish Docker Hub overview

.github/workflows/dockerhub-description.yml

@@ -0,0 +1,28 @@
+name: Docker Hub Description
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "deploy/dockerhub/README.md"
+      - ".github/workflows/dockerhub-description.yml"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Update Docker Hub overview
+        uses: peter-evans/dockerhub-description@v5
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+          repository: ${{ secrets.DOCKERHUB_USERNAME }}/dbx
+          short-description: Lightweight self-hosted database client supporting 60+ databases
+          readme-filepath: ./deploy/dockerhub/README.md

deploy/dockerhub/README.md

@@ -0,0 +1,98 @@
+# DBX
+
+DBX is a lightweight, self-hosted database client for the browser. It supports more than 60 databases, including MySQL, PostgreSQL, SQLite, Redis, MongoDB, DuckDB, ClickHouse, SQL Server, Oracle, and Elasticsearch.
+
+- Official website: https://dbxio.com
+- Documentation: https://dbxio.com/en/docs/getting-started
+- 中文文档: https://dbxio.com/cn/docs/getting-started
+- Source code: https://github.com/t8y2/dbx
+
+## Quick Start
+
+Set a strong access password and start DBX:
+
+```bash
+docker run -d \
+  --pull=always \
+  --name dbx \
+  -p 4224:4224 \
+  -e DBX_PASSWORD='change-this-password' \
+  -v dbx-data:/app/data \
+  --restart unless-stopped \
+  t8y2/dbx:latest
+```
+
+Open `http://localhost:4224` and sign in with the value of `DBX_PASSWORD`.
+
+The image supports `linux/amd64` and `linux/arm64`.
+
+## Docker Compose
+
+```yaml
+services:
+  dbx:
+    image: t8y2/dbx:latest
+    pull_policy: always
+    environment:
+      DBX_PASSWORD: change-this-password
+    ports:
+      - "4224:4224"
+    volumes:
+      - dbx-data:/app/data
+    restart: unless-stopped
+
+volumes:
+  dbx-data:
+```
+
+Start or update the service:
+
+```bash
+docker compose up -d --pull always
+```
+
+## Configuration
+
+| Variable | Default | Description |
+| --- | --- | --- |
+| `DBX_PASSWORD` | Not set | Access password for the DBX Web login page. Set a strong value for server deployments. |
+| `DBX_DISABLE_PASSWORD` | `false` | Disables login protection when set to `true`. Do not use this on an untrusted network. |
+| `DBX_DATA_DIR` | `/app/data` | Directory containing the DBX database, plugins, drivers, and other persistent data. |
+| `DBX_PORT` | `4224` | HTTP port inside the container. |
+| `DBX_PUBLIC_BASE_PATH` | `/` | URL prefix for reverse-proxy deployments, for example `/dbx`. |
+
+Persist `/app/data` with a named volume or bind mount. Removing this data removes saved connections and other DBX application data.
+
+## Reverse Proxy
+
+To publish DBX under a path such as `https://example.com/dbx`, set:
+
+```yaml
+environment:
+  DBX_PUBLIC_BASE_PATH: /dbx
+```
+
+Configure the reverse proxy to forward the same `/dbx` prefix to port `4224` in the container.
+
+## China Mirror
+
+For faster pulls in mainland China, use the CNB mirror:
+
+```text
+docker.cnb.cool/dbxio.com/dbx:latest
+```
+
+## 1Panel
+
+DBX is available from the 1Panel app store. See the official installation guide for port, password, persistence, and access instructions:
+
+- 中文教程: https://dbxio.com/cn/docs/1panel
+- English guide: https://dbxio.com/en/docs/1panel
+
+## Tags
+
+- `latest`: latest stable DBX release
+- `<version>`: a specific DBX release
+- `dev`: current development image
+
+For production deployments, pin a version tag when you need controlled upgrades.