Skip to content

Commit 6f92d03

Browse files
author
zhukai
committed
fix doc
1 parent 178c660 commit 6f92d03

File tree

2 files changed

+17
-7
lines changed

2 files changed

+17
-7
lines changed

docs/config.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,19 @@
44
|:------------------------------| :----: |:-------------------------------------------------------------------------------------------------------------|
55
| mj.accounts || 参考 [账号池配置](./config.md#%E8%B4%A6%E5%8F%B7%E6%B1%A0%E9%85%8D%E7%BD%AE%E5%8F%82%E8%80%83),配置后不需要额外设置mj.discord |
66
| mj.account-store-type || 账号存储方式,默认in_memory(内存\重启后丢失),可选redis、mysql |
7-
| mj.account-choose-rule || 账号选择策略:默认 BestWaitIdleRule(最少等待空闲)、RoundRobinRule(轮循) |
7+
| mj.account-choose-rule || 账号选择策略:默认 BestWaitIdleRule(最少等待)、RoundRobinRule(轮循) |
8+
| mj.account-sync-cron || 账号同步任务的执行时间cron,默认每天20:30执行(0 30 20 * * ?),设置为0关闭此定时任务 |
89
| mj.api-secret || 接口密钥,为空不启用鉴权;调用接口时需要加请求头 mj-api-secret |
910
| mj.username || 后台管理登录的用户名 |
1011
| mj.password || 后台管理登录的密码,默认为接口密钥(两者均未设置默认admin) |
11-
| mj.task-store.type || 任务存储方式,默认in_memory(内存\重启后丢失),可选redis、mysql |
12+
| mj.task-store.type || 任务存储方式,默认in_memory(内存\重启后丢失),可选redis、mysql |
1213
| mj.task-store.timeout || 任务存储过期时间,过期后删除,默认30天 |
1314
| mj.notify-hook || 全局的任务状态变更回调地址 |
1415
| mj.notify-notify-pool-size || 通知回调线程池大小,默认10 |
1516
| mj.proxy.host || 代理host,全局代理不生效时设置 |
1617
| mj.proxy.port || 代理port,全局代理不生效时设置 |
1718
| mj.ng-discord.server || https://discord.com 反代地址 |
19+
| mj.ng-discord.mj-says-server || https://936929561302675456.discordsays.com 反代,用于局部重绘 |
1820
| mj.ng-discord.cdn || https://cdn.discordapp.com 反代地址 |
1921
| mj.ng-discord.wss || wss://gateway.discord.gg 反代地址 |
2022
| mj.ng-discord.resume-wss || wss://gateway-us-east1-b.discord.gg 反代地址 |
@@ -74,14 +76,22 @@ spring:
7476
7577
### mysql配置参考
7678
79+
```shell
80+
# 启动myql服务
81+
docker run --name mysql8 --restart=always -p 3306:3306 -e MYSQL_ROOT_PASSWORD=novice123 -d mysql:8.0.23
82+
# 连接mysql
83+
mysql -uroot -pnovice123
84+
# 创建数据库,字符编码需为utf8mb4
85+
create database `mj_proxy` character set utf8mb4 collate utf8mb4_bin;
86+
```
7787
> 需要mysql8.0以上版本,注意用户名字段为 user
7888
```yaml
7989
spring:
8090
datasource:
8191
driver-class-name: com.mysql.cj.jdbc.Driver
8292
url: jdbc:mysql://localhost:3306/mj_proxy?serverTimezone=Asia/Shanghai&characterEncoding=utf-8&allowPublicKeyRetrieval=true&useSSL=false
8393
user: root
84-
password: novice@123
94+
password: novice123
8595
```
8696
8797
### mj.error-desc配置参考
@@ -90,6 +100,6 @@ mj:
90100
error-desc:
91101
- en: "against our community standards"
92102
zh: "可能包含违规信息"
93-
- en: "Invalid parameter"
94-
zh: "无效的参数"
103+
- en: "Request cancelled due to image filters"
104+
zh: "图片可能违规"
95105
```

docs/start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### 升级版本
44
⚠️ 注意: **不要删除docker容器**
5-
1. https://github.com/litter-coder/midjourney-proxy-plus/releases 下找到最新版本的app.jar,下载
5+
1. 获取最新版本的app.jar
66
2. 替换到config目录下,注意jar文件名需为app.jar
77
2. 重启容器,不需要重新激活
88
```shell
@@ -12,7 +12,7 @@
1212
### 初次部署
1313
1. /xxx/xxx/config目录下创建
1414
> 注意: /xxx/xxx是 服务器目录示例,需自行修改
15-
- `app.jar` 项目jar包,https://github.com/litter-coder/midjourney-proxy-plus/releases 下找到最新的jar包,下载并命名为app.jar
15+
- `app.jar` 最新的jar包,下载并命名为app.jar
1616
- `application.yml` mj配置项,参考 https://github.com/litter-coder/midjourney-proxy-plus/blob/main/resources/application.yml
1717
- `banned-words.txt` 非必须,覆盖默认的敏感词文件,参考 https://github.com/litter-coder/midjourney-proxy-plus/blob/main/resources/banned-words.txt
1818

0 commit comments

Comments
 (0)