diff --git a/README.md b/README.md index fce2f0a..27d7afe 100644 --- a/README.md +++ b/README.md @@ -100,6 +100,57 @@ npm install ```bash wails dev ``` + +## Docker Deployment + +In addition to the desktop client, Tiny RDM also provides a web version that can be quickly deployed via Docker. + +### Using Docker Compose (Recommended) + +Create a `docker-compose.yml` file: + +```yaml +services: + tinyrdm: + image: ghcr.io/tiny-craft/tiny-rdm:latest + container_name: tinyrdm + restart: unless-stopped + ports: + - "8086:8086" + environment: + - ADMIN_USERNAME=admin + - ADMIN_PASSWORD=tinyrdm + volumes: + - ./data:/app/tinyrdm +``` + +Start the service: + +```bash +docker compose up -d +``` + +Once started, visit `http://localhost:8086` and log in with the credentials configured above. + +### Using Docker Command + +```bash +docker run -d --name tinyrdm \ + -p 8086:8086 \ + -e ADMIN_USERNAME=admin \ + -e ADMIN_PASSWORD=tinyrdm \ + -v ./data:/app/tinyrdm \ + ghcr.io/tiny-craft/tiny-rdm:latest +``` + +### Environment Variables + +| Variable | Description | Default | +|----------|-------------|---------| +| `ADMIN_USERNAME` | Login username | - | +| `ADMIN_PASSWORD` | Login password | - | +| `PORT` | Go backend listen port | `8088` | + ## About ### Wechat Official Account diff --git a/README_ja.md b/README_ja.md index c12edfc..e1deaee 100644 --- a/README_ja.md +++ b/README_ja.md @@ -96,6 +96,57 @@ npm install ```bash wails dev ``` + +## Dockerデプロイ + +デスクトップクライアントに加えて、Tiny RDMはDockerで素早くデプロイできるWeb版も提供しています。 + +### Docker Composeを使用(推奨) + +`docker-compose.yml` ファイルを作成します: + +```yaml +services: + tinyrdm: + image: ghcr.io/tiny-craft/tiny-rdm:latest + container_name: tinyrdm + restart: unless-stopped + ports: + - "8086:8086" + environment: + - ADMIN_USERNAME=admin + - ADMIN_PASSWORD=tinyrdm + volumes: + - ./data:/app/tinyrdm +``` + +サービスを起動します: + +```bash +docker compose up -d +``` + +起動後、`http://localhost:8086` にアクセスし、上記で設定したユーザー名とパスワードでログインしてください。 + +### Dockerコマンドを使用 + +```bash +docker run -d --name tinyrdm \ + -p 8086:8086 \ + -e ADMIN_USERNAME=admin \ + -e ADMIN_PASSWORD=tinyrdm \ + -v ./data:/app/tinyrdm \ + ghcr.io/tiny-craft/tiny-rdm:latest +``` + +### 環境変数の説明 + +| 変数 | 説明 | デフォルト値 | +|------|------|-------------| +| `ADMIN_USERNAME` | ログインユーザー名 | - | +| `ADMIN_PASSWORD` | ログインパスワード | - | +| `PORT` | Goバックエンドのリッスンポート | `8088` | + ## について ### Wechat公式アカウント diff --git a/README_zh.md b/README_zh.md index 633a8f8..5f9566b 100644 --- a/README_zh.md +++ b/README_zh.md @@ -57,7 +57,7 @@ > sudo xattr -d com.apple.quarantine /Applications/Tiny\ RDM.app > ``` -## 构建项目 +## 构建客户端 ### 运行环境要求 @@ -96,6 +96,56 @@ npm install wails dev ``` +## Docker 部署 + +除桌面客户端外,Tiny RDM 还提供 Web 版本,可通过 Docker 快速部署。 + +### 使用 Docker Compose(推荐) + +创建 `docker-compose.yml` 文件: + +```yaml +services: + tinyrdm: + image: ghcr.io/tiny-craft/tiny-rdm:latest + container_name: tinyrdm + restart: unless-stopped + ports: + - "8086:8086" + environment: + - ADMIN_USERNAME=admin + - ADMIN_PASSWORD=tinyrdm + volumes: + - ./data:/app/tinyrdm +``` + +启动服务: + +```bash +docker compose up -d +``` + +启动后访问 `http://localhost:8086`,使用上面配置的用户名密码登录。 + +### 使用 Docker 命令 + +```bash +docker run -d --name tinyrdm \ + -p 8086:8086 \ + -e ADMIN_USERNAME=admin \ + -e ADMIN_PASSWORD=tinyrdm \ + -v ./data:/app/tinyrdm \ + ghcr.io/tiny-craft/tiny-rdm:latest +``` + +### 环境变量说明 + +| 变量 | 说明 | 默认值 | +|------|------|--------| +| `ADMIN_USERNAME` | 登录用户名 | - | +| `ADMIN_PASSWORD` | 登录密码 | - | +| `PORT` | Go 后端监听端口 | `8088` | + ## 关于 如果你也同为独立开发者(团队),喜欢开源,或者对Tiny Craft的相关产品感兴趣,可以关注微信公众号或者加入QQ群,探讨心得,反馈意见,交个朋友。