docs: add content and fix problem (#27)

* docs: add content and fix problem

* docs: some rewrite

* docs: fix ci

* docs: fis config step

Signed-off-by: 浮心物语 <[email protected]>

* docs: some changes
- add update section
- remove custom redis and mongodb in docker method

* docs: rewrite update

---------

Signed-off-by: 浮心物语 <[email protected]>

Author: wuhang2003

components/Icons/ArrowCircleUp.tsx

@@ -0,0 +1,7 @@
+import { SVGProps } from 'react'
+
+export function UilArrowCircleUp(props: SVGProps<SVGSVGElement>) {
+  return (
+    <svg xmlns="http://www.w3.org/2000/svg" width="1.5em" height="1.5em" viewBox="0 0 24 24" {...props}><path fill="currentColor" d="M12.71 8.29a1 1 0 0 0-.33-.21a1 1 0 0 0-.76 0a1 1 0 0 0-.33.21l-3 3a1 1 0 0 0 1.42 1.42l1.29-1.3V15a1 1 0 0 0 2 0v-3.59l1.29 1.3a1 1 0 0 0 1.42 0a1 1 0 0 0 0-1.42ZM12 2a10 10 0 1 0 10 10A10 10 0 0 0 12 2Zm0 18a8 8 0 1 1 8-8a8 8 0 0 1-8 8Z"></path></svg>
+  )
+}

components/Icons/ExternalLinkAlt.tsx

@@ -0,0 +1,7 @@
+import { SVGProps } from 'react';
+
+export function UilExternalLinkAlt(props: SVGProps<SVGSVGElement>) {
+  return (
+    <svg xmlns="http://www.w3.org/2000/svg" width="1.5em" height="1.5em" viewBox="0 0 24 24" {...props}><path fill="currentColor" d="M18 10.82a1 1 0 0 0-1 1V19a1 1 0 0 1-1 1H5a1 1 0 0 1-1-1V8a1 1 0 0 1 1-1h7.18a1 1 0 0 0 0-2H5a3 3 0 0 0-3 3v11a3 3 0 0 0 3 3h11a3 3 0 0 0 3-3v-7.18a1 1 0 0 0-1-1Zm3.92-8.2a1 1 0 0 0-.54-.54A1 1 0 0 0 21 2h-6a1 1 0 0 0 0 2h3.59L8.29 14.29a1 1 0 0 0 0 1.42a1 1 0 0 0 1.42 0L20 5.41V9a1 1 0 0 0 2 0V3a1 1 0 0 0-.08-.38Z"></path></svg>
+  )
+}

pages/development/_meta.json

@@ -1,4 +1,5 @@
 {
   "index": "前言",
-  "frontend": "前端开发指南"
+  "frontend": "前端开发指南",
+  "admin": "后台单独部署"
 }

pages/development/admin.mdx

@@ -0,0 +1,78 @@
+# 后台单独部署
+
+import { Callout } from 'nextra/components';
+
+在正常情况下，你不需要单独部署后台，因为后台已经被打包到了后端中。
+
+如果你有以下需求：
+
+- 想使用其他域名作为后台地址
+- 想使用其他端口作为后台地址
+
+那么你可以选择单独部署后台，或者你可以参考 [反向代理配置](/themes/kami#反向代理)。
+
+## 拉取源文件
+
+```bash
+cd mx-space
+git clone https://github.com/mx-space/mx-admin.git --depth 1
+```
+
+## 修改配置文件
+
+进入到后台源码目录，找到 `.env.production` 文件，取消对应配置项的注释，然后修改为你的配置。
+
+例如：
+
+```txt
+VITE_APP_BASE_API=https://server.test.cn/api/v2
+VITE_APP_WEB_URL=https://www.test.cn
+VITE_APP_GATEWAY=https://server.test.cn
+# # VITE_APP_PUBLIC_URL=https://fastly.jsdelivr.net/gh/mx-space/admin-next@gh-pages/
+```
+
+其他可以定义的配置在文件 `/src/configs.ts` 中。
+
+## 构建
+
+<Callout type="warning" emoji="⚠️">
+构建 mx-admin 需要的内存至少为 2 Gib，如果你服务器内存不足，你可以在本地构建成功后，将产物上传到服务器。
+
+在 Windows 系统上，mx-admin 无法正常构建，你可以使用 WSL2 或者 Linux 系统。
+</Callout>
+
+```bash
+pnpm i
+pnpm build
+```
+
+## 部署产物
+
+构建生成的产物在 dist 目录下，你可以直接把它们移动到你准备好的后台网站的根目录下。
+
+假设你准备的后台网站域名是 `admin.test.cn`，
+
+网站根目录为 `/var/www/admin.test.cn/`，
+
+那么，你把 dist 目录下的所有文件移动到 `/var/www/admin.test.cn/` 目录下即可。
+
+## 修改后端配置
+
+编辑 Core 的 `.env` 文件，修改 `ALLOWED_ORIGINS` ，添加你的后台域名。
+
+示例域名为 `admin.test.cn` 。
+
+例如：
+
+```txt
+# THIS ENV FILE EXAMPLE ONLY FOR DOCKER COMPOSE
+# SEE https://docs.docker.com/compose/environment-variables/#the-env-file
+JWT_SECRET=7294c34e0b28ad28          #此处填写一个长度不小于 16 个字符，不大于 32 个字符的字符串
+ALLOWED_ORIGINS=test.cn,www.test.cn,admin.test.cn
+```
+
+然后重新启动 Core 即可：
+
+```bash
+docker compose up -d
+```

pages/docs/_meta.json

@@ -8,5 +8,6 @@
   "docker": "Docker 部署",
   "scripts": "预设脚本部署",
   "advanced": "进阶部署",
+  "extra": "拓展内容",
   "community": "社区分享"
 }

pages/docs/extra.mdx

@@ -0,0 +1,92 @@
+# 拓展内容
+
+import { Callout } from 'nextra/components';
+
+<Callout type="warning" emoji="⚠️">
+此部分内容是可选的，在正常情况，你不需要参考这部分内容。以下部分仅针对有特定需求的用户进行参考。
+</Callout>
+
+## 配置其他 Redis 服务
+
+如果你需要使用来自 (远端 / 非容器) 的 Redis 服务，你可以通过使用 `argv` 来动态传入对应的配置项。
+
+支持传入如下值：
+
+- `redis_host` Redis 服务地址，域名、IP 都可以
+- `redis_port` Redis 服务端口
+- `redis_password` Redis 服务密码
+
+在默认情况下，我们认为这样已经足够了。
+
+### 对于进阶部署
+
+针对这种部署方式，我们可以修改 `ecosystem.config.js` 在 12 行，也就是 `script` 这一项，添加你需要传入的值，如下所示：
+
+```diff
+const { cpus } = require('os')
+const { execSync } = require('child_process')
+const nodePath = execSync(`npm root --quiet -g`, { encoding: 'utf-8' }).split(
+  '\n',
+)[0]
+
+const cpuLen = cpus().length
+module.exports = {
+  apps: [
+    {
+      name: 'mx-server',
+-     script: 'out/index.js,
++     script: 'out/index.js --redis_host=远端地址 --redis_password=redis?passwd',
+      autorestart: true,
+      exec_mode: 'cluster',
+```
+
+当你修改完成，你需要重新构建，并重启服务：
+
+```bash
+pnpm bundle
+pnpm prod:pm2
+```
+
+## 配置其他 MongoDB 服务
+
+如果你需要使用来自 (远端 / 非容器) 的 MongoDB 服务，你可以通过使用 `argv` 来动态传入对应的配置项。
+
+支持传入如下值：
+
+- `collection_name` 数据库集合名字
+- `db_host` MongoDB 服务地址，域名、IP 都可以
+- `db_port` MongoDB 服务端口
+- `db_user` MongoDB 服务用户名
+- `db_password` MongoDB 服务密码
+
+<Callout type="warning" emoji="⚠️">
+如果你需要使用密码登录，你不仅仅需要传入 password，还需要传入 user，建议你对数据库集合划分好用户权限
+</Callout>
+
+### 对于进阶部署
+
+和 Redis 一样，我们可以修改 `ecosystem.config.js` 在 12 行，也就是 `script` 这一项，添加你需要传入的值，如下所示：
+
+```diff
+const { cpus } = require('os')
+const { execSync } = require('child_process')
+const nodePath = execSync(`npm root --quiet -g`, { encoding: 'utf-8' }).split(
+  '\n',
+)[0]
+
+const cpuLen = cpus().length
+module.exports = {
+  apps: [
+    {
+      name: 'mx-server',
++     script: 'out/index.js --db_host=远端地址 --db_user=mongodb-test --db_password=db?passwd',
+      autorestart: true,
+      exec_mode: 'cluster',
+```
+
+当你修改完成，你需要重新构建，并重启服务：
+
+```bash
+pnpm bundle
+pnpm prod:pm2
+```

pages/docs/index.mdx

@@ -23,12 +23,14 @@ import { UimDocker } from '@components/Icons/Docker';
 import { UilPaintTool } from '@components/Icons/PaintTool';
 import { UimStar } from '@components/Icons/Star';
 import { FluentPeopleCommunity } from '@components/Icons/PeopleCommunity';
+import { UilExternalLinkAlt } from '@components/Icons/ExternalLinkAlt';
 
 <Cards num={2}>
   <Card arrow title="Docker 部署 （推荐）" href="/docs/docker" icon={<UimDocker />} />
   <Card arrow title="预设脚本部署" href="/docs/scripts" icon={<UilPaintTool />} />
   <Card arrow title="进阶部署" href="/docs/advanced" icon={<UimStar />} />
   <Card arrow title="社区部署教程" href="/docs/community" icon={<FluentPeopleCommunity />} />
+  <Card arrow title="拓展内容" href="/docs/extra" icon={<UilExternalLinkAlt />} />
 </Cards>
 
 还有更多部署方式吗？欢迎您向文档提交 [Pull Request](https://github.com/mx-space/docs/pulls) 以分享您的部署方式。按上方**后端部署文档**完成你的部署后，你可以通过下面的方式继续部署 Mix Space **前端** *（为什么分开部署？请查看 [一些你需要知道的事情](#一些你需要知道的事情)）*

pages/themes/kami.mdx

@@ -181,6 +181,59 @@ server {
 
 </Steps>
 
+## 更新
+
+分为对 Kami 进行魔改和未魔改两种情况。
+
+### 未魔改
+
+<Callout emoji="💡">
+该方法适合于对 Kami 源代码没有做改动的用户。
+</Callout>
+
+直接在 `kami` 文件夹下执行 `git pull origin master`：
+
+```bash
+cd ~/mx-space/kami
+git pull origin master
+```
+
+安装依赖、构建、启动前端：
+
+```bash
+pnpm i
+pnpm build
+pm2 start
+```
+
+<Callout type="warning" emoji="⚠️">
+你应该理解的是，即便是你没有对 Kami 进行任何魔改，仍有可能出现代码不能自动合并的问题，对于这种情况，建议参考下面的已魔改部分完成升级。
+</Callout>
+
+### 已魔改
+
+<Callout emoji="💡">
+此方法适用于对前端魔改后的升级，我们认为你修改了 'kami/src' 里面的源代码，这样的话，容易出现合并冲突，建议手动替换。
+</Callout>
+
+将 `kami` 文件夹改为任意名字，例如修改为 `kami.d`，然后拉取 kami 前端仓库，更新到稳定版本：
+
+```bash
+cd ~/mx-space
+git clone https://github.com/mx-space/kami.git --depth=1
+cd kami && git fetch --tags && git checkout $(git rev-list --tags --max-count=1)
+```
+
+然后将更新前之前配置时修改过的文件，如在 `kami.d` 中的 `.env` 和 `public` 文件夹复制到 `kami`，将你的修改的部分依次修改替换完成。
+
+安装依赖、构建、启动前端：
+
+```bash
+pnpm i
+pnpm build
+pm2 start
+```
+
 <style global jsx>{`
  .nextra-content pre {
      max-height: 50vh;

pages/themes/shiro/index.mdx

@@ -236,6 +236,12 @@ import { EnvVariableConfig } from '@components/EnvVariableConfig';
 
 进入 Vercel 部署此项目的仪表盘，点击上方的 Storage，进入设置页面，点击左侧的 Projects，将链接的项目取消链接，接着点击左侧的 Settings，点击右侧的 Delete Edge Config 按钮，即可完成删除。
 
+## 更新
+
+按照文档的部署方法使用 Vercel 托管的话，只需要在自己 Fork 的项目上 Sync Fork 即可（如图）。如果自己有魔改某些内容的话不要点击 Discard Changes，会把自己的魔改搞没了。
+
+![](https://pan.vinua.cn/f/GRefM/0.png)
+
 <style global jsx>{`
  .nextra-cards img {
    border-radius: 50%;

pages/usage/_meta.json

@@ -9,6 +9,7 @@
   "xlog": "xLog 集成",
   "search": "Algolia Search",
   "backup": "备份与回滚",
+  "update": "更新 Mx-Space",
   "-- community": {
     "type": "separator",
     "title": "社区使用指南"