Skip to content

Commit

Permalink
完善配置文档
Browse files Browse the repository at this point in the history
  • Loading branch information
bbbbbbbbbbbbba committed Jul 10, 2024
1 parent 08a40dd commit 1893618
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 48 deletions.
2 changes: 2 additions & 0 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,11 @@ export default defineConfig({
items: [
{
text: 'nodejs 环境安装',
link: '/docs/getstart/installation/site/install-node.html',
},
{
text: 'site 模块安装',
link: '/docs/getstart/installation/site/install-site.html',
}
]
}
Expand Down
64 changes: 16 additions & 48 deletions docs/getstart/installation/server/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@ go build

## 配置

系统提供了配置示例文件:`bbs-go.example.yaml`,将他复制一份,并命名为:`bbs-go.dev.yaml`,然后将`bbs-go.dev.yaml`中的配置修改为你自己的配置。配置示例如下:
系统提供了配置示例文件:`bbs-go.example.yaml`,将他复制一份,并命名为:`bbs-go.yaml`,然后将`bbs-go.yaml`中的配置修改为你自己的配置。

配置示例如下:

```yaml
Env: prod # 环境,线上环境:prod、测试环境:dev
Port: 8082 # 服务端口
BaseUrl: https://mlog.club # 网站域名
Port: 8082 # 端口
StaticPath: /data/www # 根路径下的静态文件目录,可配置绝对路径
IpDataPath: # IP数据文件,默认读取当前目录下ip2region.xdb文件,最新数据文件请从这里下载:https://github.com/lionsoul2014/ip2region/tree/master/data
AllowedOrigins:
- "*"
Expand All @@ -57,16 +57,16 @@ Uploader:
Enable: Oss
# 阿里云oss配置
AliyunOss:
Host: 请配置成你自己的
Bucket: 请配置成你自己的
Endpoint: 请配置成你自己的
AccessId: 请配置成你自己的
AccessSecret: 请配置成你自己的
StyleSplitter: 阿里云oss图片样式分隔符
StyleAvatar: 头像图片样式名称
StylePreview: 预览图片样式名称
StyleSmall: 小图样式名称
StyleDetail: 详情图片样式名称
Host:
Bucket:
Endpoint:
AccessId:
AccessSecret:
StyleSplitter:
StyleAvatar:
StylePreview:
StyleSmall:
StyleDetail:
# 本地文件上传
Local:
Host: https://st.mlog.club/ # 上传文件域名
Expand All @@ -76,8 +76,8 @@ Uploader:
Smtp:
Host: smtp.qq.com
Port: 25
Username: 请配置成你自己的
Password: 请配置成你自己的
Username:
Password:
SSL: true

# 百度SEO相关配置
Expand All @@ -99,35 +99,3 @@ Es:
Index: bbsgo_topic_1

```

### 基本配置

> TODO
### 日志配置

> TODO
### 数据库配置

> TODO
### 上传配置

> TODO
### ElasticSearch配置

> TODO
### SMTP邮箱服务配置

> TODO
### 百度SEO配置

> TODO
### 神马搜索SEO配置

> TODO
3 changes: 3 additions & 0 deletions docs/getstart/installation/site/install-node.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# node 环境安装

site 模块基于`nodejs 20`版本开发,编辑site模块需要先正确安装nodejs。安装教程参考官网:https://nodejs.org/zh-cn/download/package-manager
44 changes: 44 additions & 0 deletions docs/getstart/installation/site/install-site.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# 安装site模块

## 安装依赖

安装之前请确保你的电脑上正确安装了`nodejs 20+`。site模块的以来管理推荐使用pnpm,如果你的电脑上没安装pnpm,请先执行下面命令安装pnpm:

```shell
npm install -g pnpm
```

安装成功后进入源码site目录,执行下面命令安装依赖:

```shell
pnpm install
```

直至提示成功。

## 配置

在site的配置示例文件为:`.env.example`,你可以根据你不同的环境复制并重命名该文件后,修改文件中对应配置:

* 开发环境:.env.dev
* 生产环境:.env.production

目前只有一个配置项:`SERVER_URL`,该配置为server端接口服务地址,请正确配置为你自己的服务地址即可。

## 以调试模式启动

执行下面命令启动服务:

```shell
pnpm dev
```

服务默认端口为`3000`,服务启动成功后可以在浏览器中正确访问。

## 编译

执行下面命令编译服务:

```shell
pnpm build
```

0 comments on commit 1893618

Please sign in to comment.