shiliuxing / mm-wiki

a markdown mini wiki 一个轻量级的企业知识分享与团队协同软件

MM-Wiki 是一个轻量级的企业知识分享与团队协同软件，可用于快速构建企业 Wiki 和团队知识分享平台。部署方便，使用简单，帮助团队构建一个信息共享、文档管理的协作环境。

特点

• 部署方便，基于 golang 编写，只需要下载对于平台下二进制文件执行即可。
• 快速安装程序, 提供方便的安装界面程序，无需任何手动操作。
• 独立的空间，空间是一组文档的集合，一般为公司部门或者团队，空间下的文档相互独立。空间可根据需求设置空间访问级别。
• 完善的系统权限管理，系统可以自定义角色，并为不同角色授予不同的权限。
• 集成统一登录，本系统支持通过外部系统认证用户, 比如与公司的 LDAP 登录融合。具体请看登录认证功能。
• 邮件通知功能，当开启邮件通知，文档更改会通知所有关注该文档的用户。
• 文档具有分享和下载功能，目前只支持下载 MarkDown 源文件。

安装

1. 系统安装

打开 https://github.com/phachon/mm-wiki/releases 找到对应平台的版本下载编译好的压缩包

# 创建目录
$ mkdir mm_wiki
$ cd mm_wiki
# 以 linux amd64 为例，下载版本 0.1 压缩包
$ wget https://github.com/phachon/mm-wiki/releases/download/v0.1/mm-wiki-linux-amd64.tar.gz
# 解压到当前目录
$ tar -zxvf mm-wiki-linux-amd64.tar.gz
# 进入程序安装目录
$ cd install
# 执行安装程序，默认端口为 8090，指定其他端口加参数 --port=8087
$ ./install
# 浏览器访问 http://ip:8090 进入安装界面，完成安装配置
# Ctrl + C 停止 install 程序, 启动 MM-Wiki 系统
$ cd ..
$ ./mm-wiki --conf conf/mm-wiki.conf
# 开始 MM-Wiki 的使用之旅吧！

2. 如果需要，可用 nginx 配置反向代理

upstream frontends {
    server 127.0.0.1:8088; # MM-Wiki 监听的ip:port
}
server {
    listen      80;
    server_name wiki.intra.xxxxx.com www.wiki.intra.xxxxx.com;
    location / {
        proxy_pass_header Server;
        proxy_set_header Host $http_host;
        proxy_redirect off;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Scheme $scheme;
        proxy_pass http://frontends;
    }
    # 静态资源交由nginx管理
    location /static {
        root        /www/mm-wiki; # MM-Wiki 的根目录
        expires     1d;
        add_header  Cache-Control public;
        access_log  off;
    }
}

系统预览

1 安装

2 登录

3 系统

4 空间文档

5 编辑文档

6 文档分享

使用的一些插件

MM-Wiki 是站在巨人的肩膀上开发的一款软件，是因为系统中使用了非常多优秀的插件，非常感谢这些插件的作者们：

• bootstrap
• awesome-bootstrap-checkbox
• bootstrap-iconpicker
• bootstrap-select
• bootstrap-switch
• bootstrap-tagsinput
• editor.md
• layout
• layer
• metisMenu
• morris
• popover
• scrollup
• zTreev3

二次开发

环境要求：go 1.8

$ git clone https://github.com/phachon/mm-wiki.git
$ cd mm-wiki
$ go build ./

反馈

• 官方 QQ 交流群：853467682
• 如果您喜欢该项目，请 Star.
• 如果在使用过程中有任何问题， 请提交 Issue.
• 如果您发现并解决了bug，请提交 Pull Request.
• 如果您想二次开发，欢迎 Fork.
• 如果你想交个朋友，欢迎发邮件给 [e-mail].

License

MIT

谢谢

Create By phachon