mm-wiki

> 首先非常感谢大家的使用，每次看到大家的留言，感到很惭愧，最近几年没有太多精力维护，另外当初在新功能迭代的时候发现 UI 和技术栈都需要彻底的重构，所以就保持在了当前版本未继续更新。后续我决定开始计划全新版本的开发，也希望大家共同参与起来。我在5年前做这个 wiki 的初衷也是期望成为国内免费开源的最好用的wiki系统，期望可以做成和 confluence 一样伟大的产品吧。 # 特点 - 部署方便，基于 golang 编写，只需要下载对于平台下二进制文件执行即可。 - 快速安装程序, 提供方便的安装界面程序，无需任何手动操作。 - 独立的空间，空间是一组文档的集合，一般为公司部门或者团队，空间下的文档相互独立。空间可根据需求设置空间访问级别。 - 支持 markdown 语法写作，支持附件上传。 - 完善的系统权限管理，系统可以自定义角色，并为不同角色授予不同的权限。 - 集成统一登录，本系统支持通过外部系统认证用户, 比如与公司的 LDAP 登录融合。具体请看登录认证功能。 - 邮件通知功能，当开启邮件通知，文档更改会通知所有关注该文档的用户。 - 文档具有分享和下载功能，目前只支持下载 MarkDown 源文件。 - 支持文档全文搜索 # 在线快速了解 - [mm-wiki企业知识分享与团队协同软件](http://wiki.cifaz.com/), 用户名:admin, 密码:mmwiki, 点击不了请复制http://wiki.cifaz.com/ # 安装 ## 1. 自助安装 打开 https://github.com/phachon/mm-wiki/releases 找到对应平台的版本下载编译好的压缩包 - Linux 平台 ``` # 创建目录 $ mkdir mm_wiki $ cd mm_wiki # 以 linux amd64 为例，下载最新版本压缩包 # https://github.com/phachon/mm-wiki/releases 自行下载 wget http:// # 解压到当前目录 $ 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 # 浏览器访问你监听的 ip 和端口 # 开始 MM-Wiki 的使用之旅吧！ ``` - Windows 平台 ``` # 以 windows amd64 为例，下载最新版本压缩包 # https://github.com/phachon/mm-wiki/releases 自行下载 # 手动解压到当前目录 # 进入 install 目录 # 双击点开 install.exe 文件 # 浏览器访问 http://ip:8090 进入安装界面，完成安装配置 # 关闭刚刚点开的 install 窗口 # 使用 windows 命令行工具（cmd.exe）进入程序根目录 $ 执行 mm-wiki.exe --conf conf/mm-wiki.conf # 浏览器访问你监听的 ip 和端口 # 开始 MM-Wiki 的使用之旅吧！ ``` - Docker 部署 ``` … ``` ## 2. 如果需要，可用 nginx 配置反向代理 ``` … ``` # 系统预览 ### 1 安装 ### 2 登录 ### 3 系统 ### 4 空间文档 ### 5 编辑文档 ### 6 文档分享 # 使用的一些插件 MM-Wiki 是站在巨人的肩膀上开发的一款软件，是因为系统中使用了非常多优秀的插件，非常感谢这些插件的作者们： - [bootstrap](https://github.com/twbs/bootstrap) - [awesome-bootstrap-checkbox](https://github.com/flatlogic/awesome-bootstrap-checkbox) - [bootstrap-iconpicker](https://victor-valencia.github.com/bootstrap-iconpicker) - [bootstrap-select](http://silviomoreto.github.io/bootstrap-select) - [bootstrap-switch](https://bttstrp.github.io/bootstrap-switch) - [bootstrap-tagsinput](https://github.com/bootstrap-tagsinput/bootstrap-tagsinput) - [editor.md](https://github.com/pandao/editor.md) - [layout](http://jquery-dev.com) - [layer](http://layer.layui.com/) - [metisMenu](https://github.com/onokumus/metisMenu) - [morris](http://morrisjs.github.com/morris.js/) - [popover](https://github.com/sandywalker/webui-popover) - [scrollup](http://markgoodyear.com/labs/scrollup/) - [zTreev3](http://treejs.cn/) # 二次开发 环境要求：go 1.8 ``` $ git clone https://github.com/phachon/mm-wiki.git $ cd mm-wiki $ go build ./ ``` >如果你想为 mm-wiki 贡献代码，请加开发者交流群：922827699 ## 贡献者列表

phachon

cxgreat2014

ccz

Ruoran Wang

eahomliu

## 支持 请作者喝杯茶吧！ ## 反馈 - 官方 QQ 交流群：853467682 - 如果您喜欢该项目，请 [Star](https://github.com/phachon/mm-wiki/stargazers). - 如果在使用过程中有任何问题， 请提交 [Issue](https://github.com/phachon/mm-wiki/issues). - 如果您发现并解决了bug，请提交 [Pull Request](https://github.com/phachon/mm-wiki/pulls). - 如果您想二次开发，欢迎 [Fork](https://github.com/phachon/mm-wiki/network/members). - 如果你想交个朋友，欢迎发邮件给 [[email protected]](mailto:[email protected]). ## License MIT 谢谢 --- Create By phachon