feat: 优化 Debian 打包配置并初始化项目文档系统
All checks were successful
Build and Release Mond / build-and-test (arm64) (push) Successful in 4s
Build and Release Mond / build-and-test (amd64) (push) Successful in 14s
Build and Release Mond / release (push) Successful in 37s

- 简化 mond.service 配置,改为通过配置文件启动
- 优化 postinst 安装脚本,自动生成配置文件模板
- 优化 postrm 卸载脚本,正确清理数据目录
- 初始化 llmdoc 文档系统,包含项目概览、使用指南、架构说明和参考文档
- 更新 README.md 构建和配置说明
- 移除 .gitignore 中 llmdoc/ 的忽略规则
This commit is contained in:
2025-12-24 08:59:06 +08:00
parent 78f66b3c23
commit ff86a4e2bf
16 changed files with 651 additions and 39 deletions

View File

@@ -0,0 +1,27 @@
# 如何构建 Mond 项目
## 支持的平台
- Ubuntu (amd64/arm64)
- Alpine Linux (amd64/arm64)
## 构建步骤
1. **准备环境**
- 安装必要的依赖Boost、CMake、编译工具链
2. **克隆仓库**
3. **运行初始化脚本**
Project successfully modified from Monero to Mond!
Binary output name: mond
Project name: mond
4. **编译项目**
## 常见问题排查
- 确保所有 Boost 组件已正确安装
- 检查 CMake 版本兼容性
- 验证编译器支持情况

View File

@@ -0,0 +1,62 @@
# Mond 安装指南
## 支持的平台
Mond 支持以下平台和安装方式:
- Debian 12 (Bookworm)
- Debian 13 (Trixie)
- Ubuntu 最新 LTS 版本
- 通用 Linux 二进制包(支持 AMD64 和 ARM64
## 方式一Debian/Ubuntu 安装(推荐)
### Debian 12 (Bookworm)
```bash
# 1. 下载并添加 GPG 密钥
sudo curl https://gitea.bcde.io/api/packages/wangdefa/debian/repository.key \
-o /etc/apt/keyrings/gitea-wangdefa.asc
# 2. 添加软件源
echo "deb [signed-by=/etc/apt/keyrings/gitea-wangdefa.asc] https://gitea.bcde.io/api/packages/wangdefa/debian bookworm main" | \
sudo tee -a /etc/apt/sources.list.d/wangdefa.list
# 3. 安装
sudo apt-get update
sudo apt-get install mond
```
### Debian 13 (Trixie)
```bash
# 1. 下载并添加 GPG 密钥
sudo curl https://gitea.bcde.io/api/packages/wangdefa/debian/repository.key \
-o /etc/apt/keyrings/gitea-wangdefa.asc
# 2. 添加软件源
echo "deb [signed-by=/etc/apt/keyrings/gitea-wangdefa.asc] https://gitea.bcde.io/api/packages/wangdefa/debian trixie main" | \
sudo tee -a /etc/apt/sources.list.d/wangdefa.list
# 3. 安装
sudo apt-get update
sudo apt-get install mond
```
## 方式二:通用二进制包安装
```bash
# 1. 下载对应架构的包(替换 VERSION 为实际版本号)
wget https://gitea.bcde.io/releases/download/VERSION/mond-amd64-ubuntu-VERSION.tar.gz
# 2. 解压
tar -xzf mond-amd64-ubuntu-VERSION.tar.gz
# 3. 运行
./mond --help
```
## 依赖项
Mond 没有复杂的外部依赖。Debian 包管理器将自动处理必要的系统依赖。对于二进制包,请确保:
- 使用 Linux 64位系统AMD64 或 ARM64
- 具有基础 Linux 运行时环境

View File

@@ -0,0 +1,64 @@
# 如何发布 Mond 项目
## 1. 准备工作
### 前提条件
- 已配置 Gitea 仓库
- 具备仓库管理员权限
- 已安装必要的构建工具
## 2. 创建 Release
### 方法一GitHub/Gitea Web 界面
1. 导航到仓库 Releases 页面
2. 点击 "New Release"
3. 选择目标分支
4. 输入语义化版本标签(例如 `v1.2.3`
5. 填写发布说明
### 方法二:命令行
```bash
git tag -a v1.2.3 -m "Release version 1.2.3"
git push origin v1.2.3
```
## 3. 配置 Gitea Secrets
### 必需的 Secrets
- `REGISTRY_USERNAME`: 包仓库用户名
- `REGISTRY_PASSWORD`: 包仓库认证令牌
- `GPG_PRIVATE_KEY`: 用于签名的 GPG 私钥
- `GPG_PASSPHRASE`: GPG 私钥密码
### 设置步骤
1. 进入仓库设置
2. 选择 "Secrets"
3. 添加每个必需的 Secret
## 4. 包管理仓库上传
### 自动上传
- CI 流水线将自动处理
- 触发条件:新的版本标签推送
### 手动上传(备选)
```bash
# 构建 Debian 包
./debian/build-deb.sh
# 上传到包仓库
dput ppa:your-ppa-name/mond mond_1.2.3_amd64.changes
```
## 5. 发布后验证
1. 检查 GitHub/Gitea Releases
2. 验证包管理仓库的可用性
3. 测试不同平台的安装
4. 确认 systemd 服务正常运行
## 注意事项
- 遵循语义化版本Semantic Versioning
- 每次发布前运行完整的测试套件
- 更新 CHANGELOG.md

View File

@@ -0,0 +1,55 @@
# Mond 使用指南
## 基本命令和选项
### 直接运行
```bash
# 基本运行
./mond
# 指定数据目录
./mond --data-dir=/path/to/data
# 指定日志文件
./mond --log-file=/path/to/log
# 后台运行
./mond --detach
```
## Systemd 服务管理
### 服务操作
```bash
# 启用并启动服务
sudo systemctl enable mond.service
sudo systemctl start mond.service
# 查看服务状态
sudo systemctl status mond.service
# 查看实时日志
sudo journalctl -u mond -f
# 停止服务
sudo systemctl stop mond.service
# 禁用服务
sudo systemctl disable mond.service
```
## 配置和日志位置
### Debian/Ubuntu 系统包
- **二进制文件**: `/opt/mond/mond`
- **数据目录**: `/var/lib/mond/`
- **日志目录**: `/var/log/mond/`
### 通用二进制包
- **二进制文件**: 当前目录下的 `mond`
- **数据目录**: 默认为当前用户主目录下的 `.mond`
- **日志目录**: 由 `--log-file` 参数指定,默认为控制台输出