|
| 1 | +[English](README.md) | [中文](README.zh.md) |
| 2 | + |
1 | 3 |  |
2 | 4 |
|
3 | 5 | > A personal note repository that looks different🤔 |
4 | 6 |
|
5 | 7 | - Open API, more than one way to record🤩 |
6 | 8 | - Take control of your own data, come and go freely, no data hostage🙅🏻 |
7 | | -- Using docker for one-click deployment, data backup and migration are as easy as drinking water👌 |
| 9 | +- Using Docker for one-click deployment, data backup and migration are as easy as drinking water👌 |
8 | 10 |
|
9 | 11 | ## Deploy |
10 | 12 |
|
11 | | -### 快速开始 |
| 13 | +### Quick Start |
| 14 | + |
| 15 | +#### Method 1: Using Docker Hub Image (Recommended) |
12 | 16 |
|
13 | | -#### 方式一:使用 Docker Hub 镜像(推荐) |
| 17 | +> Copy `docker-compose.yml` to your server with Docker and Docker Compose installed |
| 18 | +> Note: If you use a reverse proxy, VITE_API_BASE should be your backend address after the reverse proxy |
14 | 19 |
|
15 | 20 | ```bash |
16 | | -# 使用最新版本(默认配置文件) |
17 | | -docker-compose up -d |
| 21 | +# Use latest version (default config file) |
| 22 | +VITE_API_BASE=http://<your-ip-address>:3000 docker-compose up -d |
18 | 23 |
|
19 | | -# 使用特定版本 |
| 24 | +# Use specific version |
20 | 25 | IMAGE_TAG=v1.0.0 docker-compose up -d |
21 | 26 | ``` |
22 | 27 |
|
23 | | -#### 方式二:本地构建 |
| 28 | +#### Method 2: Local Build |
24 | 29 |
|
25 | 30 | ```bash |
26 | | -# 从源码构建并启动 |
27 | | -# VITE_API_BASE 在构建时注入到前端代码中(可选,默认 http://localhost:3000) |
| 31 | +# Clone the repository |
| 32 | +git clone https://github.com/Rabithua/Rote.git |
| 33 | +cd Rote |
| 34 | + |
| 35 | +# Build and start from source |
| 36 | +# VITE_API_BASE is injected into frontend code at build time (optional, default http://localhost:3000) |
28 | 37 | VITE_API_BASE=http://localhost:3000 docker-compose -f docker-compose.build.yml up -d --build |
29 | 38 | ``` |
30 | 39 |
|
31 | | -### 详细说明 |
| 40 | +### Detailed Instructions |
32 | 41 |
|
33 | | -更多部署选项和配置说明,请查看 [Docker Compose 使用指南](doc/userguide/DOCKER-COMPOSE-GUIDE.md)。 |
| 42 | +For more deployment options and configuration instructions, please check the documentation in the `doc/` directory. |
34 | 43 |
|
35 | | -## Technology stack |
| 44 | +## Technology Stack |
36 | 45 |
|
37 | 46 |  |
0 commit comments