Skip to content
This repository was archived by the owner on Nov 2, 2024. It is now read-only.

Commit ef1478e

Browse files
committed
update
Signed-off-by: Innei <[email protected]>
1 parent 3311da7 commit ef1478e

File tree

3 files changed

+53
-43
lines changed

3 files changed

+53
-43
lines changed

pages/docs/advanced.mdx

Lines changed: 36 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# 进阶部署
22

3-
import { Callout } from 'nextra/components';
3+
import { Callout } from 'nextra/components'
44

55
<Callout type="error">
66
在您进行进阶部署前,我们给予最后的警告:如果你**不是开发者**,或者**不想折腾**,请不要选择**进阶部署**,因为它需要你具备一定的开发能力。
77

88
由于自身技术原因导致的问题,我们将**不会提供任何技术支持**。情节严重者,我们将**永久拉黑**您的账号。
9+
910
</Callout>
1011

1112
## 要求
@@ -14,7 +15,7 @@ import { Callout } from 'nextra/components';
1415
- 已安装 [Git](https://git-scm.com/downloads), [PNPM](https://pnpm.io/installation), [PM2](https://pm2.keymetrics.io/docs/usage/quick-start/)
1516
- 已安装 [MongoDB](https://www.mongodb.com/try/download/community), [Redis](https://redis.io/download) 并正常运行
1617

17-
import { Steps } from 'nextra/components';
18+
import { Steps } from 'nextra/components'
1819

1920
<Steps>
2021
### 1. 克隆并安装
@@ -34,14 +35,9 @@ pnpm bundle
3435

3536
### 3. 配置 ecosystem.config.js
3637

37-
<Configurator
38+
<Configurator
3839
args={['--color', '--encrypt_enable']}
3940
env={{
40-
MX_ENCRYPT_KEY: {
41-
type: 'password',
42-
tip: '加密密钥,可选',
43-
default: null,
44-
},
4541
PORT: {
4642
type: 'number',
4743
tip: '服务端口,可选',
@@ -102,9 +98,6 @@ pm2 start ecosystem.config.js
10298

10399
</Steps>
104100

105-
106-
107-
108101
import { useState, useEffect } from 'react';
109102
import copy from 'copy-to-clipboard';
110103

@@ -115,43 +108,44 @@ export const Configurator = ({ args, template, env }) => {
115108
);
116109
const [nowTemplate, setNowTemplate] = useState(template);
117110

118-
const handleToggleArg = (arg) => {
119-
if (selectedArgs.includes(arg)) {
120-
setSelectedArgs(selectedArgs.filter((item) => item !== arg));
121-
} else {
122-
setSelectedArgs([...selectedArgs, arg]);
123-
}
124-
};
111+
const handleToggleArg = (arg) => {
112+
if (selectedArgs.includes(arg)) {
113+
setSelectedArgs(selectedArgs.filter((item) => item !== arg));
114+
} else {
115+
setSelectedArgs([...selectedArgs, arg]);
116+
}
117+
};
125118

126-
const handleChange = (index, value) => {
127-
const updatedEnvValues = [...envValues];
128-
updatedEnvValues[index] = value;
129-
setEnvValues(updatedEnvValues);
130-
};
119+
const handleChange = (index, value) => {
120+
const updatedEnvValues = [...envValues];
121+
updatedEnvValues[index] = value;
122+
setEnvValues(updatedEnvValues);
123+
};
131124

132-
const handleCopyToClipboard = () => {
133-
copy(updatedEnvTemplate);
134-
};
125+
const handleCopyToClipboard = () => {
126+
copy(updatedEnvTemplate);
127+
};
135128

136-
useEffect(() => {
137-
const updatedTemplate = nowTemplate.replace(
138-
/args:\s*'([^']*)'/,
139-
`args: '${selectedArgs.join(' ')}'`
140-
);
141-
const updatedEnvTemplate = updatedTemplate.replace(
142-
/env:\s*{([^}]*)}/,
143-
`env: {
129+
useEffect(() => {
130+
const updatedTemplate = nowTemplate.replace(
131+
/args:\s*'([^']*)'/,
132+
`args: '${selectedArgs.join(' ')}'`
133+
);
134+
const updatedEnvTemplate = updatedTemplate.replace(
135+
/env:\s*{([^}]*)}/,
136+
`env: {
144137
${Object.keys(env)
145138
.map((key, index) => `${key}: '${envValues[index]}'`)
146139
.join(', \n ')}
147140
}`
148-
);
149-
setNowTemplate(updatedEnvTemplate);
150-
}, [selectedArgs, envValues]);
141+
);
142+
setNowTemplate(updatedEnvTemplate);
143+
}, [selectedArgs, envValues]);
151144

152-
return (
153-
<div>
154-
<div className="p-4 mt-2">
145+
return (
146+
147+
<div>
148+
<div className="p-4 mt-2">
155149

156150
<div id="config" className="border rounded-lg overflow-hidden h-12 mb-4 dark:border-gray-700 " style={{
157151
height: "66.4px",
@@ -259,5 +253,6 @@ export const Configurator = ({ args, template, env }) => {
259253
复制
260254
</button>
261255
</div>
262-
);
256+
257+
);
263258
};

pages/docs/docker.mdx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,11 @@ import { EnvVariableConfig } from '@components/EnvVariableConfig'
7171
- **`加密密钥`**:如果你不知道这是什么,那么不建议开启此功能,具体内容可参考 https://mx-space.js.org/usage/security.html
7272

7373
<Callout type="warning">
74-
若开启加密,则需注意密钥长度**必须为 64
75-
**,不然会在初始化时报错。注意这是**不可逆**的,务必保存自己的秘钥。所以并不是非常推荐使用,除非你真的需要加密,
74+
若开启加密,则需注意密钥长度**必须为 64 位**,不然会在初始化时报错。注意这是**不可逆**的,务必保存自己的秘钥。所以并不是非常推荐使用,除非你真的需要加密
75+
API Key.
76+
77+
密钥可以通过 `openssl rand -hex 32` 命令生成。请务必牢记。
78+
7679
</Callout>
7780

7881
### 启动 Core

pages/usage/security.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,14 @@ node index.js --encrypt_enable
1818

1919
可以通过附加 `--encrypt_key <key>` 来指定加密密钥,长度必须为 64 位。请牢记此密钥。或者通过环境变量 `MX_ENCRYPT_KEY` 也可以指定密钥。
2020

21+
<Callout type="warning">
22+
若开启加密,则需注意密钥长度**必须为 64 位**,不然会在初始化时报错。注意这是**不可逆**的,务必保存自己的秘钥。
23+
API Key.
24+
25+
</Callout>
26+
27+
密钥可以通过 `openssl rand -hex 32` 命令生成。请务必牢记。
28+
2129
::: info
2230
`MX_ENCRYPT_KEY` `--encrypt_key` 不是必须的,默认取机器的 [machine-id](https://www.npmjs.com/package/node-machine-id)
2331
:::
@@ -36,3 +44,7 @@ node index.js --encrypt_enable
3644
cd core
3745
tsx src/migration/helper/encrypt-configs.ts
3846
```
47+
48+
## 疑难解答
49+
50+
如果出现 `Invalid key length`,请你确定是否开启了此功能,并且 key 的长度是否为 64 位长度。

0 commit comments

Comments
 (0)