Skip to content

Commit ea9b260

Browse files
committed
fix: 更新 Bash 自动脚本文档以反映后端部署相关信息
1 parent 7bbd652 commit ea9b260

2 files changed

Lines changed: 12 additions & 30 deletions

File tree

content/docs/core/bash.mdx

Lines changed: 11 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Bash 自动脚本
3-
description: 一种自动部署 MixSpace 前后端的 Bash 脚本
3+
description: 一种自动部署 MixSpace 后端的 Bash 脚本
44
icon: SquareTerminal
55
---
66

@@ -15,7 +15,7 @@ import { ToGithub } from '@/app/components/ToGithub';
1515

1616
## 介绍
1717

18-
这是一种在服务器自动安装 Docker 和进行 MixSpace 前后端部署的 Bash 脚本,它可以帮助你交互式快速部署 MixSpace。
18+
这是一种在服务器自动安装 Docker 和进行 MixSpace 后端部署的 Bash 脚本,它可以帮助你交互式快速部署 MixSpace 后端
1919

2020
注意脚本会自动根据是否为中国大陆网络环境按需修改服务器 Docker 安装源和镜像源。
2121

@@ -28,50 +28,32 @@ import { ToGithub } from '@/app/components/ToGithub';
2828
### 海外服务器
2929

3030
```bash
31-
curl -sSL https://raw.githubusercontent.com/PaloMiku/MxShell/refs/heads/main/install.sh -o install.sh && bash install.sh
31+
curl -sSL https://raw.githubusercontent.com/PaloMiku/MxShell/refs/heads/main/install/core.sh -o core.sh && bash core.sh
3232
```
3333

3434
### 国内服务器
3535

3636
使用 Moeyy 的 GitHub 加速源。
3737

3838
```bash
39-
curl -sSL https://github.moeyy.xyz/https://raw.githubusercontent.com/PaloMiku/MxShell/refs/heads/main/install.sh -o install.sh && bash install.sh
39+
curl -sSL https://github.moeyy.xyz/https://raw.githubusercontent.com/PaloMiku/MxShell/refs/heads/main/install/core.sh -o core.sh && bash core.sh
4040
```
4141

4242
## 预配置文件
4343

44-
不建议新手使用,参考下方示例修改并粘贴到 mxconfig.yml 文件,并将其与脚本置于同一目录后运行脚本,脚本会根据配置文件内容自动完成前后端部署。
44+
参考下方示例修改并粘贴到`mxshell.env`文件,并将其与脚本置于同一目录后运行脚本,脚本会根据配置文件内容自动完成前后端部署。
4545

4646
### 配置文件示例
4747

4848
```yaml
49-
# 后端配置
50-
51-
# JWT 密钥,用于加密用户的 JWT,长度需为 16 到 32 个字符
52-
JWT_SECRET: "your_jwt_secret_here"
53-
54-
# 允许访问的域名,多个域名用英文逗号分隔
55-
ALLOWED_ORIGINS: "example.com,api.example.com"
56-
49+
# 需要填写长度不小于 16 个字符,不大于 32 个字符的字符串,用于加密用户的 JWT,务必保存好自己的密钥,不要泄露给他人。
50+
JWT_SECRET=
51+
# 需要填写被允许访问前端的域名,如果允许多个域名访问,用英文逗号,分隔。
52+
ALLOWED_ORIGINS=
5753
# MixSpace 容器文件存储目录
58-
TARGET_DIR: "/opt/mxspace"
59-
60-
# 前端配置
61-
FRONTEND:
62-
INSTALL: true
63-
VERSION: "Shiro" # 可选值: Shiro 或 Shiroi
64-
NEXT_PUBLIC_API_URL: "http://127.0.0.1:2333/api/v2"
65-
NEXT_PUBLIC_GATEWAY_URL: "http://127.0.0.1:2333/"
66-
SHIRO_IMAGE: "your-dockerhub-username/shiroi:tag" # 仅在 Shiroi 版本时需要
67-
54+
TARGET_DIR="/opt/mxspace"
6855
```
6956

7057
- **`JWT 密钥`**:需要填写长度不小于 16 个字符,不大于 32 个字符的字符串,用于加密用户的 JWT,务必保存好自己的密钥,不要泄露给他人。
7158
- **`被允许的域名`**:需要填写被允许访问容器的域名,通常是前端的域名,如果允许多个域名访问,用英文逗号,分隔。
72-
- **`MixSpace 容器文件存储目录`**:指定文件存储路径,通常是 `/opt/mxspace`
73-
- **`前端安装`**:是否安装前端,true 为安装,false 为跳过,默认为 true。
74-
- **`前端版本`**:可选值为 Shiro 或 Shiroi(闭源)。
75-
- **`前端 API 地址`**:指定后端 API 的 URL,通常为后端加 `/api/v2`
76-
- **`前端网关地址`**:指定后端网关的 URL,通常为你后端的域名。
77-
- **`Shiro 镜像`**:仅在前端版本选择为 Shiroi 版本时需要,填写你自构建的 shiroi docker 镜像信息。
59+
- **`MixSpace 容器文件存储目录`**:指定文件存储路径,通常是 `/opt/mxspace`

content/docs/core/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import { Container, SquareTerminal, Pickaxe, Share2, Ellipsis, Paintbrush } from
3232
<Cards>
3333
<Card title="Docker 部署" href="/docs/core/docker" icon={<Container />}>使用 Docker 部署后端</Card>
3434
<Card title="进阶部署" href="/docs/core/advanced" icon={<Pickaxe />}>使用传统方式部署后端</Card>
35-
<Card title="Bash 脚本部署" href="/docs/core/bash" icon={<SquareTerminal />}>使用 Bash 自动脚本一键部署前后端</Card>
35+
<Card title="Bash 脚本部署" href="/docs/core/bash" icon={<SquareTerminal />}>使用 Bash 自动脚本一键部署后端</Card>
3636
<Card title="拓展内容" href="/docs/core/extra" icon={<Ellipsis />}>部署常见问题与拓展内容</Card>
3737
<Card title="社区分享" href="/docs/core/community" icon={<Share2 />}>了解社区用户们分享的部署方式</Card>
3838
</Cards>

0 commit comments

Comments
 (0)