用来显示 markdown 文档的,基于 gin 框架的, go 语言开发的博客
一个简单高效的 Markdown 博客系统,使用 Go 语言开发。支持单文件部署、实时搜索、响应式设计和 Webhook 自动同步。
V2 版本说明:重构后的版本,将 Markdown 文件迁移到 Gitee。旧版本请查看 V1 分支
# 1. 克隆项目
git clone https://github.com/broqiang/mdblog.git
cd mdblog
# 2. 安装依赖
go mod tidy
# 3. 本地运行
make dev
# 或者
go run main.go
# 4. 访问应用
# http://localhost:8091在 posts/ 目录下创建 Markdown 文件:
---
title: "文章标题"
author: "BroQiang"
github_url: "https://github.com/broqiang/mdblog"
created_at: "2024-01-01T10:00:00Z"
updated_at: "2024-01-15T15:30:00Z"
description: "文章描述"
---
# 文章内容
这里是文章的具体内容...注意:生产环境中,posts 目录是独立的 Gitee 仓库。目前仅支持 Gitee Webhook,如需其他 Git 平台,请修改
internal/server/webhook.go中的签名验证算法。
…---
title: "文章标题" # 必填
author: "作者名" # 可选,默认 "BroQiang"
github_url: "GitHub链接" # 可选
created_at: "2024-01-01T10:00:00Z" # 可选
updated_at: "2024-01-01T12:00:00Z" # 可选
description: "文章描述" # 可选
---posts/go/article.md → 分类 "go"posts/article.md → 分类 "其他"# 创建专用用户(/bro 为家目录,可根据实际情况修改)
sudo useradd -m -d /bro -s /bin/bash bro
sudo mkdir -p /bro/mdblog/{posts,logs}
sudo chown -R bro:bro /bro/mdblog# 上传服务配置文件
scp deploy/mdblog.service user@server:/tmp/
# 安装服务
sudo cp /tmp/mdblog.service /etc/systemd/system/
sudo systemctl daemon-reload
sudo systemctl enable mdblog# 用 bro 用户克隆文章仓库
sudo -u bro git clone [email protected]:your-username/posts.git /bro/mdblog/posts
# 确保目录权限
sudo chown -R bro:bro /bro/mdblog/posts编辑 Makefile 配置:
SERVER_HOST=your-server-ip
SERVER_USER=root
SERVER_PATH=/bro/mdblog
SSH_PORT=22
APP_PORT=8091执行部署:
# 编译并部署
make build
make scp# 在服务器上生成密钥
sudo -u bro ssh-keygen -t rsa -b 4096 -C "bro@your-server"
# 查看公钥并添加到 Gitee
sudo -u bro cat /bro/.ssh/id_rsa.pub在 Gitee 仓库设置中添加 Webhook:
https://your-domain.com/webhook/gitee更新应用配置 internal/config/config.go:
const (
WebhookSecret = "your-webhook-secret"
WebhookBranch = "main"
WebhookDevMode = false // 生产环境设为 false
)make scp# 本地测试推送
cd posts
echo "# 测试文章" > test.md
git add . && git commit -m "测试" && git push origin main
# 检查同步状态
curl https://your-domain.com/health
sudo tail -f /bro/mdblog/logs/mdblog.log | grep -i webhook# 服务控制
sudo systemctl start mdblog # 启动
sudo systemctl stop mdblog # 停止
sudo systemctl restart mdblog # 重启
sudo systemctl status mdblog # 状态
# 日志查看
sudo tail -f /bro/mdblog/logs/mdblog.log # 应用日志
sudo journalctl -u mdblog -f # 系统日志
# 健康检查
curl http://localhost:8091/health
netstat -tlnp | grep 8091创建 /etc/logrotate.d/mdblog:
/bro/mdblog/logs/*.log {
daily
missingok
rotate 30
compress
delaycompress
notifempty
sharedscripts
postrotate
systemctl reload mdblog
endscript
}# 资源使用
ps aux | grep mdblog
du -sh /bro/mdblog/
# 文章统计
find /bro/mdblog/posts -name "*.md" | wc -l# 检查服务状态
sudo systemctl status mdblog
sudo journalctl -u mdblog --no-pager
# 检查端口占用
sudo netstat -tlnp | grep 8091# 检查 Git 配置
cd /bro/mdblog/posts
sudo -u bro git status
sudo -u bro git remote -v
# 测试 SSH 连接
sudo -u bro ssh -T [email protected]
# 检查文件权限
ls -la /bro/mdblog/posts/# 重置权限
sudo chown -R bro:bro /bro/mdblog
sudo chmod 755 /bro/mdblog
sudo chmod 755 /bro/mdblog/posts/
sudo chmod 644 /bro/mdblog/posts/*.md# 默认配置
./mdblog
# 自定义 posts 目录
./mdblog -posts /path/to/posts主要配置在 internal/config/config.go:
const (
DefaultPort = 8091
DefaultHost = "0.0.0.0"
SummaryLines = 3
PageSize = 10
WebhookSecret = "secret"
WebhookBranch = "main"
WebhookDevMode = false
)GET /api/posts?page=1&size=10 # 获取文章列表
GET /api/posts/{id} # 获取单篇文章
GET /api/categories # 获取分类列表
GET /api/search?q=关键词&page=1&size=10 # 搜索文章GET /health # 健康检查
POST /webhook/gitee # Gitee WebhookCmd(macOS)或 Ctrl(Windows/Linux)bro 运行服务,避免 root 权限MIT License - 详见 LICENSE 文件
MDBlog - 让 Markdown 写作更简单,让博客部署更轻松!
No open issues yet, or sync has not completed.