环境要求
运行时
| 资源 | 要求 |
|---|
| 运行时 | Node.js 22+ |
| 包管理器 | pnpm(推荐) |
| CPU | 1 核(开发/小团队够用) |
| 内存 | 512 MB 以上 |
| 磁盘 | 视文档量而定 |
依赖
- 无外部服务依赖:不需要安装数据库、缓存、消息队列等中间件
- SQLite:内嵌在 better-sqlite3 中,零配置
- 文档存储:直接使用文件系统
存储布局
运行时数据集中存储在 ~/.mdocs/ 目录下:
~/.mdocs/
sqlite/
data.sqlite # 元数据(文档索引、访客、权限、审计日志)
files/
docs/
{domain_id}/ # 每个域独立的子目录
a.md # 域内文档(Lexical JSON 格式)
assets/ # 上传的附件
logs/ # 运行日志(按日期轮转)
可通过环境变量 MDOCS_DATA_DIR 自定义数据目录位置。
网络
- 默认监听
127.0.0.1:4000(仅本地访问)
- 生产部署建议通过反向代理对外暴露(见反向代理)