Skip to content

iiinsomnia/godoc

Repository files navigation

godoc

go开发的一个简单易用的文档管理系统,用于API等文档的管理

特点

  • 采用golang开发,部署简单
  • 只有一个执行文件,不依赖任何前端静态资源
  • 文档采用 markdown 编辑,程序员的最爱

运行

  • release 下载编译好的执行文件
  • 创建数据库 (godoc - utf8mb4/utf8mb4_general_ci) 并导入 godoc.sql
  • 在 env.ini.dev => env.ini 文件中配置数据库信息
  • 执行相应操作系统的可执行文件
  • 访问:localhost:8000

log.xml.dev => log.xml 为日志配置文件,如有需要,请修改此文件

如果你是golang开发者,可以下载源码,go get github.com/iiinsomnia/yiigo 后自己运行

Mac & Linux

cd /godoc

# mac
./godoc_darwin
# 如需后台运行,则:
./godoc_darwin &

# linux
./godoc_linux_x64
# 如需后台运行,则:
./godoc_linux_x64 &

Windows

双击运行即可

说明

  • 测试登录用户:admin/admin、demo/123
  • 访问端口可以在配置文件中设置,默认:8000
  • 新增用户初始密码可以在配置文件中设置,默认:123
  • 如需配置域名,建议使用 nginx 反向代理