From 07fc49db5cd7e4bcd7fffc5b641f86898d1e1766 Mon Sep 17 00:00:00 2001 From: "henry.chen" Date: Tue, 5 Aug 2025 14:26:17 +0800 Subject: [PATCH] chore: update docs --- README.md | 15 ++++++----- cmd/backup/etc/app.yml | 2 +- cmd/backup/handler/timer/db/mgodb.go | 9 ++++--- cmd/eiblog/CHANGELOG.md | 5 ---- compose.yml | 6 +++-- docs/backup.md | 29 ++++++++++---------- docs/install.md | 40 +++++++++++++++++++--------- 7 files changed, 62 insertions(+), 44 deletions(-) delete mode 100644 cmd/eiblog/CHANGELOG.md diff --git a/README.md b/README.md index 524380e..1363e32 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ # EiBlog [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE.md) [![Versuib](https://img.shields.io/github/tag/eiblog/eiblog.svg)](https://github.com/eiblog/eiblog/releases) -> 博客项目结构参考模版：https://github.com/deepzz0/appdemo - -用过其它博客系统，不喜欢，不够轻，不够快！这是我开发的第二款博客系统，也实在不想再在这件事情上过多纠结了。`EiBlog` 是一个比较稳定的博客系统，现已迭代至 `2.0` 版本，稳定性和维护你是不用担心的。 +用过其它博客系统，不喜欢，不够轻，不够快！这是我开发的第二款博客系统，也实在不想再在这件事情上过多纠结了。`EiBlog` 是一个比较稳定的博客系统，现已迭代至 `3.0` 版本，稳定性和维护你是不用担心的。 但它有着部署简单（上线复杂！）的特点，不推荐没有计算机知识的朋友搭建，欢迎咨询。该博客的个中优点（简洁、轻快，安全），等你体验。 @@ -12,6 +10,13 @@ Docker镜像地址： * 博客搜索：[deepzz0/elasticsearch](https://hub.docker.com/r/deepzz0/elasticsearch) * 数据备份：[deepzz0/backup](https://hub.docker.com/r/deepzz0/backup) +### 功能变化 + +- [x] 增对 **TOTP 双因素认证** 的支持，配置开启后后台绑定 +- [x] 新增 **自定义页面**，支持独立页面和内嵌页面 +- [x] 优化项目结构，更加清晰，各个 app 之间配置独立 +- [ ] 支持多搜索引擎，如数据库原生、[zincsearch](https://github.com/zincsearch/zincsearch)、bleve 等 + ### 快速体验 **二进制** @@ -33,8 +38,6 @@ $ docker run --name eiblog \ 参考项目根目录下的 [docker-compose.yml](https://github.com/eiblog/eiblog/blob/v2/docker-compose.yml)，修改相关配置： ``` -$ docker compose up -d -或 $ docker-compose up -d ``` @@ -46,7 +49,7 @@ $ docker-compose up -d | 类型（driver） | 地址（source）示例 | | -------------- | ------------------------------------------------------------ | -| mongodb | mongodb://localhost:27017 | +| mongodb | mongodb://localhost:27017/eiblog | | mysql | user:password@tcp(localhost:3306)/eiblog?charset=utf8mb4&parseTime=True&loc=Local | | postgres | host=localhost port=5432 user=user password=password dbname=eiblog sslmode=disable | | sqlite | /path/eiblog.db | diff --git a/cmd/backup/etc/app.yml b/cmd/backup/etc/app.yml index 08ae065..5f80034 100644 --- a/cmd/backup/etc/app.yml +++ b/cmd/backup/etc/app.yml @@ -3,7 +3,7 @@ apimode: listen: 0.0.0.0:9000 database: # 数据库配置 driver: mongodb - source: mongodb://localhost:27017 + source: mongodb://localhost:27017/eiblog backupto: qiniu # 备份到, default: qiniu interval: 7d # 备份周期, default: 7d validity: 60 # 备份保留时间, default: 60 diff --git a/cmd/backup/handler/timer/db/mgodb.go b/cmd/backup/handler/timer/db/mgodb.go index 8e407ec..db20f6a 100644 --- a/cmd/backup/handler/timer/db/mgodb.go +++ b/cmd/backup/handler/timer/db/mgodb.go @@ -24,14 +24,17 @@ func (r MongoStorage) Backup(name string) (string, error) { if err != nil { return "", err } - arg := fmt.Sprintf("mongodump -h %s -d eiblog -o /tmp", u.Host) + if u.Path == "" { + return "", fmt.Errorf("no database specified") + } + arg := fmt.Sprintf("mongodump -h %s -d %s -o /tmp", u.Host, u.Path) cmd := exec.CommandContext(ctx, "sh", "-c", arg) err = cmd.Run() if err != nil { return "", err } // tar - arg = fmt.Sprintf("tar czf /tmp/%s -C /tmp eiblog", name) + arg = fmt.Sprintf("tar czf /tmp/%s -C /tmp %s", name, u.Path) cmd = exec.CommandContext(ctx, "sh", "-c", arg) err = cmd.Run() if err != nil { @@ -66,7 +69,7 @@ func (r MongoStorage) Restore(path string) error { if err != nil { return err } - arg = fmt.Sprintf("mongorestore -h %s -d eiblog /tmp/eiblog", u.Host) + arg = fmt.Sprintf("mongorestore -h %s -d %s /tmp/%s", u.Host, u.Path, u.Path) cmd = exec.CommandContext(ctx, "sh", "-c", arg) return cmd.Run() } diff --git a/cmd/eiblog/CHANGELOG.md b/cmd/eiblog/CHANGELOG.md deleted file mode 100644 index fc91ede..0000000 --- a/cmd/eiblog/CHANGELOG.md +++ /dev/null @@ -1,5 +0,0 @@ -# Changelog - -All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. - -### [3.0.3](https://github.com/eiblog/eiblog/compare/v3.0.2...v3.0.3) (2025-07-25) diff --git a/compose.yml b/compose.yml index f283a76..2deaa79 100644 --- a/compose.yml +++ b/compose.yml @@ -13,7 +13,7 @@ services: eiblog: image: deepzz0/eiblog:latest volumes: - - ${PWD}/eiblog/etc:/app/etc + - ${PWD}/eiblog/etc/app.yml:/app/etc/app.yml extra_hosts: - "disqus.com:151.101.192.134" - "deepzz.disqus.com:151.101.192.134" @@ -30,7 +30,9 @@ services: image: deepzz0/backup:latest #command: ./backend --restore true volumes: - - ${PWD}/backup/etc:/app/etc + - ${PWD}/backup/etc/app.yml:/app/etc/app.yml links: - mongodb + environment: + - RUN_MODE=prod restart: always diff --git a/docs/backup.md b/docs/backup.md index b7e87c4..cd62ff0 100644 --- a/docs/backup.md +++ b/docs/backup.md @@ -7,19 +7,20 @@ EiBlog 镜像仓库地址：https://hub.docker.com/u/deepzz0，备份镜像为 目前仅支持同步 mongodb 数据到七牛云，参考 `app.yml`： ``` -backupapp: - mode: - name: cmd-backup - enablehttp: true - httpport: 9001 - backupto: qiniu # 备份到七牛云 - interval: 7d # 多久备份一次 - validity: 60 # 保存时长days - qiniu: # 七牛OSS - bucket: backup - domain: st.deepzz.com - accesskey: MB6AXl_Sj_mmFsL-Lt59Dml2Vmy2o8XMmiCbbSeC - secretkey: BIrMy0fsZ0_SHNceNXk3eDuo7WmVYzj2-zrmd5Tf +apimode: + name: cmd-backup + listen: 0.0.0.0:9000 +database: # 数据库配置 + driver: mongodb + source: mongodb://localhost:27017/eiblog +backupto: qiniu # 备份到, default: qiniu +interval: 7d # 备份周期, default: 7d +validity: 60 # 备份保留时间, default: 60 +qiniu: # 七牛OSS + bucket: eiblog + domain: st.deepzz.cn + accesskey: MB6AXl_Sj_mmFsL-Lt59Dml2Vmy2o8XMmiCbbSeC + secretkey: BIrMy0fsZ0_SHNceNXk3eDuo7WmVYzj2-zrmd5Tf ``` @@ -36,7 +37,7 @@ $ docker pull deepzz0/backup ``` $ docker run --name backup \ - -v ${PWD}/conf:/app/conf + -v ${PWD}/etc/app.yml:/app/etc/app.yml ``` Docker-compose 请参考项目根目录下的 `docker-compose.yml` 文件。 diff --git a/docs/install.md b/docs/install.md index ba38edc..f0156bb 100644 --- a/docs/install.md +++ b/docs/install.md @@ -5,7 +5,7 @@ * [准备工作](#准备工作) * [开始部署](#开始部署) -博主提供了下面将要用到的镜像，可到这里查看：[https://hub.docker.com/u/deepzz0](https://hub.docker.com/u/deepzz0)。由于所有配置均在 `app/conf.yml` 下，所以在通过 docker 部署时建议将配置映射出来方便调试。 +博主提供了下面将要用到的镜像，可到这里查看：[https://hub.docker.com/u/deepzz0](https://hub.docker.com/u/deepzz0)。在通过 docker 部署时建议将配置映射出来方便调试。 ### 存储后端 @@ -13,7 +13,7 @@ ``` # driver # source -mongodb mongodb://localhost:27017 +mongodb mongodb://localhost:27017/eiblog postgres host=localhost port=5432 user=user dbname=eiblog sslmode=disable password=password mysql user:password@tcp(127.0.0.1:3306)/eiblog?charset=utf8mb4&parseTime=True&loc=Local sqlite /path/eiblog.db @@ -74,8 +74,8 @@ eshost: http://localhost:9200 | favicon.ico | st.example.com/static/img/favicon.ico | cdn 名为 `static/img/favicon.ico`。你也可以在代理服务器自行配置，只要通过 example.com/favicon.ico 也是能够访问到。 | | bg04.jpg | st.example.com/static/img/bg04.jpg | cdn 名为 `static/img/bg04.jpg`，首页左侧的大背景图，需要更名请到 website/st_blog.css 修改。 | | avatar.png | st.example.com/static/img/avatar.png | cdn 名为 `static/img/avatar.png`，个人博客头像 | -| blank.gif | st.example.com/static/img/blank.gif | cdn 名为 `static/img/blank.gif`，空白图片，复制链接下载 https://st.deepzz.com/static/img/blank.gif。 | -| default_avatar.png | st.example.com/static/img/default_avatar.png | cdn 名为 `static/img/default_avatar.png`，disqus 默认头像图片，复制链接下载 https://st.deepzz.com/static/img/default_avatar.png | +| blank.gif | st.example.com/static/img/blank.gif | cdn 名为 `static/img/blank.gif`，空白图片，复制链接下载 https://st.deepzz.cn/static/img/blank.gif。 | +| default_avatar.png | st.example.com/static/img/default_avatar.png | cdn 名为 `static/img/default_avatar.png`，disqus 默认头像图片，复制链接下载 https://st.deepzz.cn/static/img/default_avatar.png | > 注意： > @@ -85,21 +85,27 @@ eshost: http://localhost:9200 #### 配置说明 -走到这里，我相信只走到 `80%` 的路程。放弃还来得及。这里会对 `eiblog/conf` 下的所有文件做说明，希望你做好准备。 +走到这里，我相信只走到 `80%` 的路程。这里会对 `cmd/eiblog/etc` 下的所有文件做说明： -具体的配置内容已经在 `app.yml` 中进行说明了。 +``` +cmd/eiblog/etc +├── app.yml # 博客配置文件 +├── assets # 后台所需的资源文件 +├── page # 自定义的页面文件 +├── template # 前台渲染的模板 +└── xml # xml 渲染模板，如 sitemap +``` -如果用 nginx 作为代理服务器，博主提供了一份示例配置 `eiblog/eiblog.conf`，该配置涉及到 `ssl` 相关配置建议存放于 `/etc/nginx/ssl` 下。其中关于 `ssl_dhparam`、站点认证均提供了相关配置。 +具体的配置内容已经在 `app.yml` 中进行说明了。如果用 nginx 作为代理服务器，博主提供了一份示例配置 `eiblog/eiblog.conf`，该配置涉及到 `ssl` 相关配置建议存放于 `/etc/nginx/ssl` 下。其中关于 `ssl_dhparam`、站点认证均提供了相关配置。 ### 开始部署 下面是博主通过 `docker-compose` 一键部署的文件内容，仅供参考： ``` -version: '3' services: mongodb: - image: mongo:3.2 + image: mongo:3.6 volumes: - ${PWD}/mgodb:/data/db restart: always @@ -108,24 +114,32 @@ services: volumes: - ${PWD}/esdata:/usr/share/elasticsearch/data restart: always + eiblog: - iamge: deepzz0/eiblog:latest + image: deepzz0/eiblog:latest volumes: - - ${PWD}/conf:/app/conf + - ${PWD}/eiblog/etc/app.yml:/app/etc/app.yml extra_hosts: - "disqus.com:151.101.192.134" + - "deepzz.disqus.com:151.101.192.134" links: - elasticsearch - mongodb + environment: + - RUN_MODE=prod ports: - - 9000:9000 + - 127.0.0.1:9000:9000 restart: always + backup: image: deepzz0/backup:latest + #command: ./backend --restore true volumes: - - ${PWD}/conf:/app/conf + - ${PWD}/backup/etc/app.yml:/app/etc/app.yml links: - mongodb + environment: + - RUN_MODE=prod restart: always ```