Skip to content

Commit 8009d1c

Browse files
author
zhukai
committed
doc: 文档完善
1 parent 9d0c9d0 commit 8009d1c

File tree

4 files changed

+24
-5
lines changed

4 files changed

+24
-5
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
- [x] 账号池持久化,动态维护
2626
- [x] 每个账号可设置对应的任务队列(参考 [MidJourney订阅级别](https://docs.midjourney.com/docs/plans) 调整)
2727
- [x] 支持获取账号/info、/settings信息
28-
- [x] mj管理后台
28+
- [x] 内嵌 [管理后台页面](https://github.com/litter-coder/midjourney-proxy-admin)
2929

3030
## 后续计划
3131

@@ -41,7 +41,26 @@
4141
加入我们即可获得
4242

4343
- midjourney-proxy的最新版本
44-
- 内嵌 [管理后台](https://github.com/litter-coder/midjourney-proxy-admin)
4544
- [微信机器人最新版本](https://github.com/litter-coder/wechat-ai)
4645
- 及时维护,出问题优先修复
4746
- 您的意见和建议会被我们重点采纳
47+
48+
## 使用前提
49+
1. 注册并订阅 MidJourney,创建自己的频道,参考 https://docs.midjourney.com/docs/quick-start
50+
2. 获取用户Token、服务器ID、频道ID等:[获取方式](./docs/discord-params.md)
51+
52+
## 配置项
53+
- mj.accounts: 参考 [账号池配置](./docs/config.md#%E8%B4%A6%E5%8F%B7%E6%B1%A0%E9%85%8D%E7%BD%AE%E5%8F%82%E8%80%83)
54+
- mj.account-store-type: 账号存储方式,默认in_memory(内存\重启后丢失),可选redis
55+
- mj.task-store.type: 任务存储方式,默认in_memory(内存\重启后丢失),可选redis
56+
- mj.task-store.timeout: 任务存储过期时间,过期后删除,默认30天
57+
- mj.api-secret: 接口密钥,为空不启用鉴权;调用接口时需要加请求头 mj-api-secret
58+
- mj.translate-way: 中文prompt翻译成英文的方式,可选null(默认)、baidu、gpt、deepl
59+
- mj.translate-zh-way: describe、shorten等结果翻译成中文的方式,可选null(默认)、baidu、gpt、deepl
60+
- redis、翻译或更多配置查看 [配置项](./docs/config.md)
61+
62+
## 相关文档
63+
- [部署教程](./docs/start.md)
64+
- [全部配置项](./docs/config.md)
65+
- [API接口说明](./docs/api.md)
66+
- [Release版本jar包地址](https://github.com/litter-coder/midjourney-proxy-plus/releases)

docs/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# API接口说明
22

3-
`http://ip:port/mj` 已有api文档,此处仅作补充
3+
`http://ip:port/doc` 已有api文档,此处仅作补充
44

55
## 1. 数据结构
66

docs/discord-params.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,5 @@
1919

2020
### 4. 获取MJ私信ID
2121

22-
url里取出 私信ID,后续设置到账号的 `mj-bot-channel-id`
22+
url里取出 私信ID,后续设置到账号的 `mj-bot-channel-id`,获取图片seed功能需要用到
2323
![Midjourney @me](bot-me.png)

docs/start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Docker
44

5-
1. /xxx/xxx/config目录下创建
5+
1. 创建/xxx/xxx/config,docker用户需要有读写权限,目录文件如下
66
> 注意: /xxx/xxx是 服务器目录示例,需自行修改
77
- `app.jar` 项目jar包,https://github.com/litter-coder/midjourney-proxy-plus/releases 下找到最新的jar包,下载并命名为app.jar
88
- `application.yml` mj配置项,参考 https://github.com/litter-coder/midjourney-proxy-plus/blob/main/resources/application.yml

0 commit comments

Comments
 (0)