Skip to content

Commit b55c269

Browse files
committed
✨ feat: add storage config document
1 parent d151211 commit b55c269

File tree

2 files changed

+124
-0
lines changed

2 files changed

+124
-0
lines changed

docs/admin/docker.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: 容器化
3+
order: 12
4+
nav:
5+
order: 1
6+
title: admin
7+
description: 在容器中运行mss-boot-admin
8+
keywords: [admin docker run]
9+
---
10+
## 准备环境
11+
[本地安装docker环境](https://blog.csdn.net/m0_67393295/article/details/126327312?ops_request_misc=%257B%2522request%255Fid%2522%253A%2522170460779016800180620265%2522%252C%2522scm%2522%253A%252220140713.130102334..%2522%257D&request_id=170460779016800180620265&biz_id=0&utm_medium=distribute.pc_search_result.none-task-blog-2~all~top_click~default-2-126327312-null-null.142^v99^pc_search_result_base1&utm_term=docker%20desktop%E4%BD%BF%E7%94%A8%E6%95%99%E7%A8%8B&spm=1018.2226.3001.4187)
12+
13+
## 运行mysql
14+
```shell
15+
docker run -d \
16+
--name mysql \
17+
--network host \
18+
-e MYSQL_ROOT_PASSWORD=123456 \
19+
-e MYSQL_DATABASE=mss-boot-admin-local \
20+
-p 3306:3306 \
21+
mysql:8
22+
```
23+
## 迁移数据
24+
```shell
25+
docker run \
26+
--rm \
27+
--network host \
28+
ghcr.io/mss-boot-io/mss-boot-admin:latest \
29+
migrate
30+
```
31+
## 运行服务端
32+
```shell
33+
docker run -d \
34+
--name mss-boot-admin \
35+
--network host \
36+
-p 8080:8080 \
37+
ghcr.io/mss-boot-io/mss-boot-admin:latest \
38+
server
39+
```
40+
## 运行前端
41+
```shell
42+
docker run -d \
43+
--name mss-boot-admin-antd \
44+
--network host \
45+
-p 8000:80 \
46+
ghcr.io/mss-boot-io/mss-boot-admin-antd:latest
47+
```

docs/admin/tutorials.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,80 @@ oauth2:
5252
export CLIENTID=xxxx
5353
export CLIENTSECRET=xxxx
5454
```
55+
56+
### 缓存配置
57+
:::info
58+
利用缓存模块(memory/redis)可以提高系统性能,同时系统的应用配置模块也支持缓存配置,可以通过缓存配置来提高系统性能,自己在开发时,可以合理利用缓存来提高系统性能。
59+
:::
60+
> `mss-boot-admin`的缓存配置支持`redis`和`memory`两种缓存方式,`memory`为内存缓存一般用于本地开发,`redis`为redis缓存,一般用于生产环境,如下所示:
61+
>
62+
#### 将redis密码作为环境变量传入
63+
```shell
64+
export REDIS_PASSWORD=xxxx
65+
```
66+
#### 配置memory缓存
67+
```yaml
68+
cache:
69+
memory: ''
70+
```
71+
#### 配置redis缓存
72+
```yaml
73+
cache:
74+
redis:
75+
addr: 'localhost:6379'
76+
password: {{ .Env.REDIS_PASSWORD }}
77+
db: 9
78+
```
79+
80+
### 队列配置
81+
:::info
82+
利用队列模块(memory/kafka/redis/nsq)可以将一些耗时的任务放入队列中,然后异步执行,这样可以提高系统性能,同时系统的应用配置模块也支持队列配置,可以通过队列配置来提高系统性能和可靠性,自己在开发时,可以合理利用队列。
83+
:::
84+
> `mss-boot-admin`的队列配置支持`memory`、`kafka`、`nsq`和`redis`四种队列方式,`memory`为内存队列一般用于本地开发,`kafka`为kafka队列,一般用于生产环境,`nsq`为nsq队列,一般用于生产环境且对消息没有顺序要求的场景,`redis`为redis队列,一般用于负载极小的场景。
85+
>
86+
:::warning
87+
`kafka`适用于对消息有顺序要求的场景,`nsq`适用于对消息没有顺序要求的场景,`redis`适用于负载极小的场景,请根据自己的业务场景选择合适的队列。
88+
:::
89+
#### 配置memory队列
90+
```yaml
91+
queue:
92+
memory:
93+
poolNum: 10 # 队列池大小
94+
```
95+
#### 配置kafka队列
96+
```yaml
97+
queue:
98+
kafka:
99+
brokers:
100+
- 'localhost:9092'
101+
version: '3.6.0' # kafka版本(默认1.0.0)
102+
```
103+
#### 配置nsq队列
104+
```yaml
105+
queue:
106+
nsq:
107+
addresses:
108+
- 'localhost:4150'
109+
lookupdAddr: 'localhost:4161' # nsqlookupd地址, 用于监听和topic管理nsqd节点, 供消费者使用
110+
adminAddr: 'localhost:4171' # nsqadmin地址, 用于获取所有节点信息供生产者使用
111+
```
112+
### 分布式锁配置
113+
:::info
114+
利用分布式锁可以解决分布式环境下的并发问题,同时系统的应用配置模块也支持分布式锁配置,可以通过分布式锁配置来解决分布式环境下的并发问题,自己在开发时,可以合理利用分布式锁。
115+
:::
116+
> `mss-boot-admin`的分布式锁配置只支持`redis`,一般用于生产环境。
117+
>
118+
#### 配置redis分布式锁
119+
```yaml
120+
### 如果cache和queue都没有使用redis,需要完整配置redis
121+
locker:
122+
redis:
123+
addr: 'localhost:6379'
124+
password: {{ .Env.REDIS_PASSWORD }}
125+
db: 9
126+
```
127+
```yaml
128+
### 如果cache或queue使用redis,只需要配置redis这个参数即可
129+
locker:
130+
redis: {}
131+
```

0 commit comments

Comments
 (0)