Skip to content

Commit e381c9f

Browse files
author
zhukai
committed
update Docs
1 parent e7a0da7 commit e381c9f

File tree

4 files changed

+50
-30
lines changed

4 files changed

+50
-30
lines changed

‎README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,15 @@
1919
- [x] 支持焦点移动: Pan ⬅️ ➡️ ⬆️ ⬇️
2020
- [x] 支持图片变焦: Zoom 🔍
2121
- [x] 支持局部重绘: Vary (Region) 🖌
22-
- [x] 支持几乎所有的关联按钮动作和🎛️ Remix模式，参考 [API接口说明-执行动作](./docs/api.md#3-%E6%89%A7%E8%A1%8C%E4%BB%BB%E5%8A%A1%E7%9A%84%E5%85%B3%E8%81%94%E5%8A%A8%E4%BD%9C)
22+
- [x] 支持所有的关联按钮动作和 🎛️Remix模式，参考 [API接口说明-执行动作](./docs/api.md#3-%E6%89%A7%E8%A1%8C%E4%BB%BB%E5%8A%A1%E7%9A%84%E5%85%B3%E8%81%94%E5%8A%A8%E4%BD%9C)
2323
- [x] 支持获取图片的seed值
2424
- [x] 账号池持久化，动态维护
2525
- [x] 账号、任务存储支持内存、Redis、MySQL
26-
- [x] 支持获取账号/info、/settings信息
27-
- [x] 账号settings设置
28-
- [x] 内嵌 [管理后台页面](https://github.com/litter-coder/midjourney-proxy-admin)
29-
26+
- [x] 支持获取账号/info、/settings信息，更改settings设置
27+
- [x] 支持取消等待、进行中的任务
28+
- [x] 内嵌管理后台页面: 支持账号维护、任务查看、绘图测试等
29+
- [x] 支持 [niji・journey Bot](https://discord.com/invite/nijijourney)，需加入自己的服务器
30+
- [x] 支持 [InsightFace 人脸服务](https://discord.com/api/oauth2/authorize?client_id=1090660574196674713&permissions=274877945856&scope=bot)
3031

3132
## 获取方式
3233

‎docs/api.md

Lines changed: 31 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,31 +5,40 @@
55
## 1. 数据结构
66

77
### 任务
8-
| 字段 | 类型 | 示例 | 描述 |
9-
|:-----:|:----:|:----|:----|
10-
| id | string | 1689231405853400 | 任务ID |
11-
| action | string | IMAGINE | 任务类型: IMAGINE（绘图）、UPSCALE（放大）、VARIATION（变化）、ZOOM（图片变焦）、PAN（焦点移动）、DESCRIBE（图生文）、BLEND（图片混合）、SHORTEN（prompt分析） |
12-
| status | string | SUCCESS | 任务状态: NOT_START（未启动）、SUBMITTED（已提交处理）、MODAL（窗口等待）、IN_PROGRESS（执行中）、FAILURE（失败）、SUCCESS（成功） |
13-
| prompt | string | 猫猫 | 提示词 |
14-
| promptEn | string | Cat | 英文提示词 |
15-
| description | string | /imagine 猫猫 | 任务描述 |
16-
| submitTime | number | 1689231405854 | 提交时间 |
17-
| startTime | number | 1689231442755 | 开始执行时间 |
18-
| finishTime | number | 1689231544312 | 结束时间 |
19-
| progress | string | 100% | 任务进度 |
20-
| imageUrl | string | https://cdn.discordapp.com/attachments/xxx/xxx/xxxx.png | 生成图片的url, 成功或执行中时有值，可能为png或webp |
21-
| failReason | string | [Invalid parameter] Invalid value | 失败原因, 失败时有值 |
22-
| properties | object | {"finalPrompt": "Cat"} | 任务的扩展属性，系统内部使用 |
23-
| buttons | Button[] | [] | 任务完成后的可执行按钮 |
8+
| 字段 | 类型 | 示例 | 描述 |
9+
|:-----:|:----:|:----|:-----------------------------------------------------------------------------------------------------------------------------|
10+
| id | string | 1689231405853400 | 任务ID |
11+
| action | string | IMAGINE | 任务类型: IMAGINE（绘图）、UPSCALE（放大）、VARIATION（变化）、ZOOM（图片变焦）、PAN（焦点移动）、DESCRIBE（图生文）、BLEND（图片混合）、SHORTEN（prompt分析）、SWAP_FACE（人脸替换） |
12+
| status | string | SUCCESS | 任务状态: NOT_START（未启动）、SUBMITTED（已提交处理）、MODAL（窗口等待）、IN_PROGRESS（执行中）、FAILURE（失败）、SUCCESS（成功）、CANCEL（已取消） |
13+
| prompt | string | 猫猫 | 提示词 |
14+
| promptEn | string | Cat | 英文提示词 |
15+
| description | string | /imagine 猫猫 | 任务描述 |
16+
| submitTime | number | 1689231405854 | 提交时间 |
17+
| startTime | number | 1689231442755 | 开始执行时间 |
18+
| finishTime | number | 1689231544312 | 结束时间 |
19+
| progress | string | 100% | 任务进度 |
20+
| imageUrl | string | https://cdn.discordapp.com/attachments/xxx/xxx/xxxx.png | 生成图片的url, 成功或执行中时有值，可能为png或webp |
21+
| failReason | string | [Invalid parameter] Invalid value | 失败原因, 失败时有值 |
22+
| properties | object | {"finalPrompt": "Cat"} | 任务的扩展属性，系统内部使用 |
23+
| buttons | Button[] | [] | 任务完成后的可执行按钮 |
2424

2525
### Button
26-
| 字段 | 类型 | 示例 | 描述 |
27-
|:-----:|:----:|:----|:----|
26+
| 字段 | 类型 | 示例 | 描述 |
27+
|:---------|:----:|:----|:----|
2828
| customId | string | MJ::JOB::upsample::1::85a4b4c1-8835-46c5-a15c-aea34fad1862 | 动作标识 |
29-
| emoji | string | 🪄 | 图标 |
30-
| label | string | Make Variations | 文本 |
31-
| type | number | 2 | 类型，系统内部使用 |
32-
| style | number | 2 | 样式: 2（Primary）、3（Green） |
29+
| emoji | string | 🪄 | 图标 |
30+
| label | string | Make Variations | 文本 |
31+
| type | number | 2 | 类型，系统内部使用 |
32+
| style | number | 2 | 样式: 2（Primary）、3（Green） |
33+
34+
### properties 常见字段
35+
| 字段 | 类型 | 示例 | 描述 |
36+
|:---------------|:----:|:------------------------------------------|:---------------------------------------------|
37+
| botType | string | NIJI_JOURNEY | bot类型: MID_JOURNEY,NIJI_JOURNEY,INSIGHT_FACE |
38+
| discordInstanceId | string | 1118138338562560102 | 执行该任务的实例ID(频道ID) |
39+
| finalPrompt | string | Cat | 消息内容提取出的prompt |
40+
| messageId | string | 1174910863984033903 | 消息ID |
41+
| messageContent | string | `**Cat** - Image #1 <@590422081204912129>` | 消息内容 |
3342

3443
## 2. 任务提交返回
3544
- code=1: 提交成功，result为任务ID

‎docs/config.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,17 @@
99
| mj.api-secret | 否 | 接口密钥，为空不启用鉴权；调用接口时需要加请求头 mj-api-secret |
1010
| mj.username | 否 | 后台管理登录的用户名 |
1111
| mj.password | 否 | 后台管理登录的密码，默认为接口密钥(两者均未设置默认admin) |
12+
| mj.admin-image-prefix | 否 | admin管理页图片前缀，可设置 `https://wsrv.nl/?url=` 等反代discord图片 |
1213
| mj.task-store.type | 否 | 任务存储方式，默认in_memory(内存\重启后丢失)，可选redis、mysql |
1314
| mj.task-store.timeout | 否 | 任务存储过期时间，过期后删除，默认30天 |
1415
| mj.notify-hook | 否 | 全局的任务状态变更回调地址 |
1516
| mj.notify-notify-pool-size | 否 | 通知回调线程池大小，默认10 |
1617
| mj.proxy.host | 否 | 代理host，全局代理不生效时设置 |
1718
| mj.proxy.port | 否 | 代理port，全局代理不生效时设置 |
1819
| mj.ng-discord.server | 否 | https://discord.com 反代地址 |
19-
| mj.ng-discord.mj-says-server | 否 | https://936929561302675456.discordsays.com 反代，用于局部重绘 |
2020
| mj.ng-discord.cdn | 否 | https://cdn.discordapp.com 反代地址 |
21+
| mj.ng-discord.mj-says-server | 否 | https://936929561302675456.discordsays.com 反代，用于局部重绘(该地址可能不需要反代，先自行测试) |
22+
| mj.ng-discord.upload-server | 否 | https://discord-attachments-uploads-prd.storage.googleapis.com 反代，用于上传文件 |
2123
| mj.ng-discord.wss | 否 | wss://gateway.discord.gg 反代地址 |
2224
| mj.ng-discord.resume-wss | 否 | wss://gateway-us-east1-b.discord.gg 反代地址 |
2325
| mj.translate-way | 否 | 中文prompt翻译成英文的方式，可选null(默认)、baidu、gpt、deepl |

‎docs/start.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,14 @@
44
⚠️ 注意: **不要删除docker容器**
55
1. 获取最新版本的app.jar
66
2. 替换到config目录下，注意jar文件名需为app.jar
7-
2. 重启容器，不需要重新激活
7+
3. 重启容器，不需要重新激活
88
```shell
99
docker restart midjourney-proxy-plus
1010
```
11+
4. 若服务有问题，请查看docker日志
12+
```shell
13+
docker logs -f -n 100 midjourney-proxy-plus
14+
```
1115

1216
### 初次部署
1317
1. /xxx/xxx/config目录下创建
@@ -23,6 +27,10 @@
2327
-v /xxx/xxx/config:/home/spring/config \
2428
novicezk/plus-jdk17:latest
2529
```
30+
3. 若服务有问题，请查看docker日志
31+
```shell
32+
docker logs -f -n 100 midjourney-proxy-plus
33+
```
2634

27-
3. 在API文档页 `http://ip:port/doc` 服务激活 -> 获取机器码，联系作者获取激活码，激活服务
2835
4. 访问 `http://ip:port` 查看管理页面，用户名默认是admin，密码默认是设置的接口密钥（未设置默认密码是admin）
36+
5. 登录后按照指引激活服务

0 commit comments

Comments
 (0)