{"id":13550944,"url":"https://github.com/phachon/mm-wiki","last_synced_at":"2025-05-13T17:07:47.516Z","repository":{"id":37430989,"uuid":"136314388","full_name":"phachon/mm-wiki","owner":"phachon","description":"MM-Wiki 一个轻量级的企业知识分享与团队协同软件，可用于快速构建企业 Wiki 和团队知识分享平台。部署方便，使用简单，帮助团队构建一个信息共享、文档管理的协作环境。","archived":false,"fork":false,"pushed_at":"2025-04-06T15:10:16.000Z","size":26374,"stargazers_count":3692,"open_issues_count":172,"forks_count":844,"subscribers_count":97,"default_branch":"master","last_synced_at":"2025-04-24T01:53:15.770Z","etag":null,"topics":["api-docs","confluence","docs","document-management","documentation","documents","documentserver","dokuwiki","wiki"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/phachon.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-06-06T10:44:22.000Z","updated_at":"2025-04-23T06:43:37.000Z","dependencies_parsed_at":"2022-07-22T00:29:46.636Z","dependency_job_id":"ae98b55c-2d5e-4f32-9997-07a7bbfb1ce3","html_url":"https://github.com/phachon/mm-wiki","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phachon%2Fmm-wiki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phachon%2Fmm-wiki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phachon%2Fmm-wiki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phachon%2Fmm-wiki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phachon","download_url":"https://codeload.github.com/phachon/mm-wiki/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253990466,"owners_count":21995774,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-docs","confluence","docs","document-management","documentation","documents","documentserver","dokuwiki","wiki"],"created_at":"2024-08-01T12:01:40.017Z","updated_at":"2025-05-13T17:07:42.505Z","avatar_url":"https://github.com/phachon.png","language":"Go","funding_links":[],"categories":["Go","documentation"],"sub_categories":[],"readme":"\u003ch2 align=\"center\"\u003e\n\n![brand](./static/images/logo_sm.png)\n\n\u003c/h2\u003e\n\n\u003e 首先非常感谢大家的使用，每次看到大家的留言，感到很惭愧，最近几年没有太多精力维护，另外当初在新功能迭代的时候发现 UI 和技术栈都需要彻底的重构，所以就保持在了当前版本未继续更新。后续我决定开始计划全新版本的开发，也希望大家共同参与起来。我在5年前做这个 wiki 的初衷也是期望成为国内免费开源的最好用的wiki系统，期望可以做成和 confluence 一样伟大的产品吧。\n\n\u003cdiv align=\"center\"\u003e\n\nMM-Wiki 是一个轻量级的企业知识分享与团队协同软件，可用于快速构建企业 Wiki 和团队知识分享平台。部署方便，使用简单，帮助团队构建一个信息共享、文档管理的协作环境。\n\u003c/br\u003e\n\n[![stable](https://img.shields.io/badge/stable-stable-green.svg)](https://github.com/phachon/mm-wiki/) \n[![build](https://img.shields.io/shippable/5444c5ecb904a4b21567b0ff.svg)](https://travis-ci.org/phachon/mm-wiki)\n[![license](http://img.shields.io/badge/license-MIT-red.svg?style=flat)](https://raw.githubusercontent.com/phachon/mm-wiki/master/LICENSE)\n[![platforms](https://img.shields.io/badge/platform-All-yellow.svg?style=flat)]()\n[![download_count](https://img.shields.io/github/downloads/phachon/mm-wiki/total.svg?style=plastic)](https://github.com/phachon/mm-wiki/releases) \n[![release](https://img.shields.io/github/release/phachon/mm-wiki.svg?style=flat)](https://github.com/phachon/mm-wiki/releases) \n\n\u003c/div\u003e\n\n# 特点\n- 部署方便，基于 golang 编写，只需要下载对于平台下二进制文件执行即可。\n- 快速安装程序, 提供方便的安装界面程序，无需任何手动操作。\n- 独立的空间，空间是一组文档的集合，一般为公司部门或者团队，空间下的文档相互独立。空间可根据需求设置空间访问级别。\n- 支持 markdown 语法写作，支持附件上传。\n- 完善的系统权限管理，系统可以自定义角色，并为不同角色授予不同的权限。\n- 集成统一登录，本系统支持通过外部系统认证用户, 比如与公司的 LDAP 登录融合。具体请看登录认证功能。\n- 邮件通知功能，当开启邮件通知，文档更改会通知所有关注该文档的用户。\n- 文档具有分享和下载功能，目前只支持下载 MarkDown 源文件。\n- 支持文档全文搜索\n\n# 在线快速了解\n- [mm-wiki企业知识分享与团队协同软件](http://wiki.cifaz.com/), 用户名:admin, 密码:mmwiki, 点击不了请复制http://wiki.cifaz.com/\n\n# 安装\n## 1. 自助安装\n\n打开 https://github.com/phachon/mm-wiki/releases 找到对应平台的版本下载编译好的压缩包\n\n- Linux 平台\n\n    ```\n    # 创建目录\n    $ mkdir mm_wiki\n    $ cd mm_wiki\n    # 以 linux amd64 为例，下载最新版本压缩包\n    # https://github.com/phachon/mm-wiki/releases 自行下载 wget http://\n    # 解压到当前目录\n    $ tar -zxvf mm-wiki-linux-amd64.tar.gz\n    # 进入程序安装目录\n    $ cd install\n    # 执行安装程序，默认端口为 8090，指定其他端口加参数 --port=8087\n    $ ./install\n    # 浏览器访问 http://ip:8090 进入安装界面，完成安装配置\n    # Ctrl + C 停止 install 程序, 启动 MM-Wiki 系统\n    $ cd ..\n    $ ./mm-wiki --conf conf/mm-wiki.conf\n    # 浏览器访问你监听的 ip 和端口\n    # 开始 MM-Wiki 的使用之旅吧！\n    ```\n\n- Windows 平台\n\n    ```\n    # 以 windows amd64 为例，下载最新版本压缩包\n    # https://github.com/phachon/mm-wiki/releases 自行下载\n    # 手动解压到当前目录\n    # 进入 install 目录\n    # 双击点开 install.exe 文件\n    # 浏览器访问 http://ip:8090 进入安装界面，完成安装配置\n    # 关闭刚刚点开的 install 窗口\n    # 使用 windows 命令行工具（cmd.exe）进入程序根目录\n    $ 执行 mm-wiki.exe --conf conf/mm-wiki.conf\n    # 浏览器访问你监听的 ip 和端口\n    # 开始 MM-Wiki 的使用之旅吧！\n    ```\n\n- Docker 部署\n    ```\n    # 数据库准备\n    # 导入docs/databases/data.sql和docs/databases/table.sql（注：需取消注释data.sql中第一条管理用户插入语句）\n\n    # 两种部署方式可用\n    # DockerHub（推荐）\n    # 从DockerHub下载v0.1.7版本\n    # 新增配置文件，数据存放目录以及Mysql数据库配置在mm-wiki.conf配置文件中设置\n    # 挂载配置文件及数据存放目录，启动端口为8080\n    # docker run -d -p 8080:8081 -v /data/mm-wiki/conf/:/opt/mm-wiki/conf/ -v /data/mm-wiki/data:/data/mm-wiki/data/ --name mm-wiki eahom/mm-wiki:v0.1.7\n\n    # 本地构建最新代码\n    # 构建项目镜像\n    # docker build -t mm-wiki-image .\n    # 新增配置文件，数据存放目录以及Mysql数据库配置在mm-wiki.conf配置文件中设置\n    # 挂载配置文件及数据存放目录，启动端口为8080\n    # docker run -d -p 8080:8081 -v /data/mm-wiki/conf/:/opt/mm-wiki/conf/ -v /data/mm-wiki/data/:/data/mm-wiki/data/ --name mm-wiki mm-wiki-image\n    ```\n## 2. 如果需要，可用 nginx 配置反向代理\n```\nupstream frontends {\n    server 127.0.0.1:8088; # MM-Wiki 监听的ip:port\n}\nserver {\n    listen      80;\n    server_name wiki.intra.xxxxx.com www.wiki.intra.xxxxx.com;\n    location / {\n        proxy_pass_header Server;\n        proxy_set_header Host $http_host;\n        proxy_redirect off;\n        proxy_set_header X-Real-IP $remote_addr;\n        proxy_set_header X-Scheme $scheme;\n        proxy_pass http://frontends;\n    }\n    # 静态资源交由nginx管理\n    location /static {\n        root        /www/mm-wiki; # MM-Wiki 的根目录\n        expires     1d;\n        add_header  Cache-Control public;\n        access_log  off;\n    }\n}\n```\n\n# 系统预览\n\n### 1 安装\n![install](./static/images/preview/install.png)\n### 2 登录\n![login](./static/images/preview/login.png)\n### 3 系统\n![system](./static/images/preview/system.png)\n### 4 空间文档\n![space](./static/images/preview/space.png)\n### 5 编辑文档\n![edit](./static/images/preview/edit.png)\n### 6 文档分享\n![share](./static/images/preview/share.png)\n\n# 使用的一些插件\n\nMM-Wiki 是站在巨人的肩膀上开发的一款软件，是因为系统中使用了非常多优秀的插件，非常感谢这些插件的作者们：\n\n- [bootstrap](https://github.com/twbs/bootstrap)\n- [awesome-bootstrap-checkbox](https://github.com/flatlogic/awesome-bootstrap-checkbox)\n- [bootstrap-iconpicker](https://victor-valencia.github.com/bootstrap-iconpicker)\n- [bootstrap-select](http://silviomoreto.github.io/bootstrap-select)\n- [bootstrap-switch](https://bttstrp.github.io/bootstrap-switch)\n- [bootstrap-tagsinput](https://github.com/bootstrap-tagsinput/bootstrap-tagsinput)\n- [editor.md](https://github.com/pandao/editor.md)\n- [layout](http://jquery-dev.com)\n- [layer](http://layer.layui.com/)\n- [metisMenu](https://github.com/onokumus/metisMenu)\n- [morris](http://morrisjs.github.com/morris.js/)\n- [popover](https://github.com/sandywalker/webui-popover)\n- [scrollup](http://markgoodyear.com/labs/scrollup/)\n- [zTreev3](http://treejs.cn/)\n\n# 二次开发\n\n环境要求：go 1.8\n```\n$ git clone https://github.com/phachon/mm-wiki.git\n$ cd mm-wiki\n$ go build ./\n```\n\n\u003e如果你想为 mm-wiki 贡献代码，请加开发者交流群：922827699\n\n## 贡献者列表\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://phachon.com\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/19726268?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003ephachon\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/phachon/mm-wiki/commits?author=phachon\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/cxgreat2014\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/15062548?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003ecxgreat2014\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/phachon/mm-wiki/commits?author=cxgreat2014\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/cifaz\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/4531158?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eccz\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/phachon/mm-wiki/commits?author=cifaz\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://www.linkedin.com/in/wangruoran/\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/25990237?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eRuoran Wang\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/phachon/mm-wiki/commits?author=ruoranw\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/eahomliu\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/50134691?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eeahomliu\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/phachon/mm-wiki/commits?author=eahomliu\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"https://github.com/phachon/mm-wiki/commits?author=eahomliu\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-enable --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\n## 支持\n请作者喝杯茶吧！\n\n\n## 反馈\n- 官方 QQ 交流群：853467682\n- 如果您喜欢该项目，请 [Star](https://github.com/phachon/mm-wiki/stargazers).\n- 如果在使用过程中有任何问题， 请提交 [Issue](https://github.com/phachon/mm-wiki/issues).\n- 如果您发现并解决了bug，请提交 [Pull Request](https://github.com/phachon/mm-wiki/pulls).\n- 如果您想二次开发，欢迎 [Fork](https://github.com/phachon/mm-wiki/network/members).\n- 如果你想交个朋友，欢迎发邮件给 [phachon@163.com](mailto:phachon@163.com).\n\n## License\n\nMIT\n\n谢谢\n---\n\nCreate By phachon\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphachon%2Fmm-wiki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphachon%2Fmm-wiki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphachon%2Fmm-wiki/lists"}