Skip to content

Commit 30f0de3

Browse files
committed
update docs
1 parent 1ea6144 commit 30f0de3

File tree

3 files changed

+20
-14
lines changed

3 files changed

+20
-14
lines changed

docs/guide/deploy/Docker.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,12 @@ title: Docker 部署
6161

6262
2. env
6363

64-
进入 `deploy/backend/docker-compose` 目录,拷贝环境变量文件 `.env.server`
64+
进入 `deploy/backend/docker-compose` 目录,按需修改 `.env.server` 文件
65+
66+
::: note
67+
我们在 docker-compose 脚本内通过挂载的方式直接使用此文件作为 fba 环境变量文件,因此,本地修改此文件,将同步更新至 docker
68+
容器,这意味着,修改环境变量将无需重新 build
69+
:::
6570

6671
::: warning
6772
如果你需要使用 PostgreSQL 数据库,执行命令前,需修改 `.env.server` 部分配置如下:
@@ -74,11 +79,7 @@ title: Docker 部署
7479
```
7580
:::
7681

77-
```shell
78-
cp .env.server ../../../backend/.env
79-
```
80-
81-
3. 按需修改配置文件 `backend/core/conf.py``backend/.env`
82+
3. 按需修改配置文件 `backend/core/conf.py`
8283

8384
4. 更新脚本文件
8485

@@ -97,6 +98,7 @@ title: Docker 部署
9798
- fba_redis
9899
- fba_celery
99100
volumes:
101+
- .env.server:/fba/backend/.env
100102
- fba_static:/fba/backend/app/static
101103
networks:
102104
- fba_network
@@ -111,7 +113,7 @@ title: Docker 部署
111113
supervisorctl restart fastapi_server
112114
113115
fba_mysql:
114-
image: mysql:8.0.29
116+
image: mysql:8.0.41
115117
ports:
116118
- "${DOCKER_MYSQL_MAP_PORT:-3306}:3306"
117119
container_name: fba_mysql
@@ -148,15 +150,15 @@ title: Docker 部署
148150
- fba_network
149151

150152
fba_redis:
151-
image: redis:6.2.7
153+
image: redis
152154
ports:
153155
- "${DOCKER_REDIS_MAP_PORT:-6379}:6379"
154156
container_name: fba_redis
155157
restart: always
156158
environment:
157159
- TZ=Asia/Shanghai
158160
volumes:
159-
- fba_redis:/var/lib/redis
161+
- fba_redis:/usr/local/etc/redis
160162
networks:
161163
- fba_network
162164

@@ -214,7 +216,7 @@ title: Docker 部署
214216

215217
fba_rabbitmq:
216218
hostname: fba_rabbitmq
217-
image: rabbitmq:3.12.7
219+
image: rabbitmq:3.13.7
218220
ports:
219221
- "15672:15672"
220222
- "5672:5672"

docs/guide/summary/quick-start.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ title: 快速开始
3030

3131
2. 准备 Git 仓库
3232

33-
::: info
33+
::: note
3434
两种方案,选择其中一种即可
3535
:::
3636

@@ -52,12 +52,16 @@ title: 快速开始
5252

5353
3. 安装依赖包
5454

55+
::: note
56+
无论你正在使用 uv 还是 pip,fba 内都不包含任何国内源配置,默认使用官方源,如果您需要依赖包加速,请自行 Google 配置国内源
57+
:::
58+
5559
- 架构依赖
5660

5761
拉取项目到本地后,进入项目 `backend` 目录,执行以下命令安装架构依赖
5862

5963
```shell
60-
pip install -r requirements.txt
64+
pip install -r requirements.txt
6165
```
6266

6367
- 插件依赖

docs/plugin/market.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ title: 插件市场
1515
- <Badge type="tip" text="fba" /> - 仅后端代码插件
1616
- <Badge text="fba-arco" color="#4582ff"/> - 包含前端 [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui) 代码插件
1717
- <Badge text="fba-vben" color="#c178ec"/> - 包含前端 [fba_ui](https://github.com/fastapi-practices/fba_ui) 代码插件
18-
- <Badge text="app" color="#D6DD59"/> - 独立 app 插件
19-
- <Badge text="app-extra" color="#59C7DD"/> - 非独立 app 插件 / 内置 app 扩展
18+
- <Badge text="app" color="#D6DD59"/> - 应用级插件
19+
- <Badge text="app-extra" color="#59C7DD"/> - 扩展级插件
2020

2121
:::
2222

0 commit comments

Comments
 (0)