streamerzero/md

Markdown、OpenAPI文档服务器镜像

镜像概述

本镜像为Markdown和OpenAPI文档服务器，用于托管、展示Markdown格式文档及OpenAPI规范文档，支持灵活的数据库配置和用户注册管理，适用于团队或个人文档集中管理场景。

核心功能与特性

• 支持Markdown格式文档托管与在线展示
• 支持OpenAPI规范文档解析与展示
• 数据库灵活选择：默认使用SQLite，可配置PostgreSQL数据库
• 用户注册控制：通过环境变量配置是否允许新用户注册（无用户时默认允许注册）

使用场景

• 开发团队内部技术文档、接口文档集中管理
• OpenAPI规范API文档在线托管与分享
• 个人项目文档、知识库在线展示

源码地址

[***]

使用方法与配置

快速启动示例

bash
docker run -d --name md --restart always \
  -p 9900:9900 \
  -v /etc/localtime:/etc/localtime:ro \
  -v /home/docker/md:/md/data \
  -e reg=true \
  streamerzero/md

参数说明：

• -d：后台运行容器
• --name md：指定容器名称为md
• --restart always：容器退出时自动重启
• -p 9900:9900：端口映射（宿主机端口:容器端口）
• -v /etc/localtime:/etc/localtime:ro：同步宿主机时间
• -v /home/docker/md:/md/data：挂载数据目录（持久化数据）
• -e reg=true：允许用户注册

环境变量配置

数据库选择

• PostgreSQL模式：当上述pg_host、pg_port、pg_user、pg_password、pg_db五个环境变量全部配置时，系统将使用PostgreSQL数据库
• SQLite模式：未完整配置PostgreSQL参数时，默认使用SQLite数据库（数据文件存储于/md/data目录）

目录说明