Skip to content

Commit

Permalink
fix: core deploy (#68)
Browse files Browse the repository at this point in the history
* fix: backup

* refactor: shiro deploy

* fix: update docker deploy

* fix: ci

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

---------

Signed-off-by: 浮心物语 <[email protected]>
  • Loading branch information
wuhang2003 committed May 15, 2024
1 parent 3314d83 commit 5927d76
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 24 deletions.
8 changes: 6 additions & 2 deletions pages/docs/docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ docker compose version

### 拉取配置文件

<Callout type="warning" emoji="⚠️">
自 Core v5.7.5 版本开始,Docker 相关配置发生重大变化,请重新阅读本文档(尤其是填入配置文件环节,配置有所变化)
</Callout>

```bash
cd && mkdir -p mx-space/core && cd $_

Expand All @@ -38,7 +42,7 @@ wget https://fastly.jsdelivr.net/gh/mx-space/core@master/docker-compose.yml

### 配置 Core 启动配置文件

在下方的表格里填入你的配置,然后点击复制,创建一个 `.env` 文件,将复制的内容粘贴进去,保存即可。
在下方的表格里填入你的配置,然后点击复制,覆盖 `docker-compose.yml``environment` 字段对应部分的内容,调整细节使其符合 yaml 语法,保存即可。

> 鼠标悬停在下方的表格中,可以查看对应的配置项名字。
Expand All @@ -52,7 +56,7 @@ import { EnvVariableConfig } from '@components/EnvVariableConfig'
},
{
key: 'ALLOWED_ORIGINS',
name: '[被允许的域名] 如果允许多个域名访问,用英文逗号分隔',
name: '[被允许的域名] 如果允许多个域名访问,用英文逗号,分隔',
},
{
key: 'ENCRYPT_ENABLE',
Expand Down
64 changes: 42 additions & 22 deletions pages/themes/shiro/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,34 +31,22 @@ import { ToGitHub } from '@components/ToGitHub'
## 前提要求

- 你已安装 Mix Space 后端并且已启动
- 你已注册 [Vercel](https://vercel.com/)[GitHub](https://github.com/) 账号
- 你已注册 [Clerk](https://clerk.com/) 账号
- (选择 Vercel 部署)已注册 [Vercel](https://vercel.com/)[GitHub](https://github.com/) 账号

<Callout type="warning">
请注意,Shiro 主题的部署教程与初版有所不同,如果你已经部署过 Shiro
主题,请重新阅读本文档(尤其是填入配置文件环节,配置有所变化),并阅读最后一节
[「移除 Edge Config」](#移除-edge-config)
主题,请重新阅读本文档(尤其是填入配置文件环节,配置有所变化),并阅读
[「移除 Edge Config」](#移除-edge-config) 部分
</Callout>

## 安装
## 准备步骤

import { Steps } from 'nextra/components'
import Video from '@components/Video'

<Steps>

### 克隆仓库

登陆 GitHub 账号,打开 [Innei/Shiro](https://github.com/Innei/Shiro),点击右上角的 Fork 按钮,将仓库克隆到你的账号下。

<Video src="https://pan.vinua.cn/f/73dt6/fork_shiro.mp4" />

### 打开 Vercel 创建项目

登陆 Vercel 账号,点击右上角的 New Project 按钮,选择 Import Git Repository,选择你刚刚 Fork 的仓库,点击 Import 按钮,即可进入到项目配置页面。

<Video src="https://pan.vinua.cn/f/52ocj/shiro_create_new_project.mp4" />

### 打开 Clerk 创建项目

打开 [Clerk 仪表盘](https://dashboard.clerk.com/) 点击 Add application 按钮,填入你的博客名称,并配置信息,点击 Create application 按钮,即可完成配置。
Expand Down Expand Up @@ -287,13 +275,39 @@ import { EnvVariableConfig } from '@components/EnvVariableConfig'
]}
/>

</Steps>

## 通过 Vercel 部署

<Steps>

### 克隆仓库

登陆 GitHub 账号,打开 [Innei/Shiro](https://github.com/Innei/Shiro),点击右上角的 Fork 按钮,将仓库克隆到你的账号下。

<Video src="https://pan.vinua.cn/f/73dt6/fork_shiro.mp4" />

### 打开 Vercel 创建项目

登陆 Vercel 账号,点击右上角的 New Project 按钮,选择 Import Git Repository,选择你刚刚 Fork 的仓库,点击 Import 按钮,即可进入到项目配置页面。

<Video src="https://pan.vinua.cn/f/52ocj/shiro_create_new_project.mp4" />

### 键入环境变量 & 开始部署

在刚刚进入的 Vercel 项目配置页面中,点击 Environment Variables,然后键盘上的 Ctrl + V 将环境变量粘贴到输入框中,然后点击 Deploy 按钮,等待部署完成。

有关配置自定义域名的教程,请参考 [Vercel 文档](https://vercel.com/docs/custom-domains)

<Video src="https://pan.vinua.cn/f/g3YfL/shiro_deploy.mp4" />

### Clerk 登录与 Mix Space 后端绑定
</Steps>

## 通过预构建运行 & Docker Compose

参见 [README 相关部分](https://github.com/Innei/Shiro/blob/main/README.md#whale-运行) 完成对应操作,随后配置[反向代理](/docs/extra#反向代理)

## Clerk 登录与 Mix Space 后端绑定

如果你遇到在 Shiro 登录之后,无法评论遇到 "和主人重名" 的报错,是因为 Clerk 的用户名和 Mix Space 后端的用户名重复了,你需要绑定本系统和 Clerk 的用户。让某个 Clerk 用户具有管理员权限。

Expand All @@ -319,11 +333,9 @@ Key:

Refer: https://github.com/Innei/Shiro/issues/137

### 完成!

至此,你已完成了 Shiro 主题的部署,你可以访问你的博客了。有关配置域名的教程,请参考 [Vercel 文档](https://vercel.com/docs/custom-domains)
## 完成!

</Steps>
至此,你已完成了 Shiro 主题的部署,你可以访问你的博客了。

## 移除 Edge Config

Expand All @@ -333,10 +345,18 @@ Refer: https://github.com/Innei/Shiro/issues/137

## 更新

按照文档的部署方法使用 Vercel 托管的话,只需要在自己 Fork 的项目上 Sync Fork 即可(如图)。如果自己有魔改某些内容的话不要点击 Discard Changes,会把自己的魔改搞没了。
### Vercel 托管

使用 Vercel 托管的话,只需要在自己 Fork 的项目上 Sync Fork 即可(如图)。如果自己有魔改某些内容的话不要点击 Discard Changes,会把自己的魔改搞没了。

![](https://pan.vinua.cn/f/GRefM/0.png)

### 通过预构建运行 & Docker Compose

预构建:重复对应步骤。

Docker Compose:`docker compose pull && docker compose up -d`

<style global jsx>{`
.nextra-cards img {
border-radius: 50%;
Expand Down

0 comments on commit 5927d76

Please sign in to comment.