© 加速工具
jiasugongju#
outlook.com

MM-Wiki 是一款轻量级的企业知识分享与团队协同软件,用于快速搭建企业 Wiki 和团队知识分享平台。

• 便捷部署:基于 Go 语言编写,只需下载对应平台的二进制文件并执行。

• 快速安装:提供简便的安装界面程序,无需手动操作。

• 独立空间:空间是文档的集合,通常对应公司部门或团队,空间内文档相互独立。可按需设置空间访问权限。

• Markdown 支持:支持 Markdown 语法编写,允许上传附件。

• 权限管理:完善的系统权限管理,可自定义角色并分配不同权限。

• 统一登录:支持通过外部系统认证用户,例如与公司 LDAP 登录集成。

• 邮件通知:开启邮件通知后,文档更改会通知所有关注该文档的用户。

• 文档分享与下载:文档具备分享和下载功能,目前仅支持下载 Markdown 源文件。

• 全文搜索:支持文档全文搜索。

安装指南

Linux 平台

1、创建目录并进入

mkdir mm_wiki && cd mm_wiki

2、下载最新版本压缩包(以 Linux amd64 为例)

wget [下载链接]

3、解压到当前目录

tar -zxvf mm-wiki-linux-amd64.tar.gz

4、进入程序安装目录,执行安装程序

cd install
./install

默认端口为 8090,可通过 --port=8087 参数指定其他端口。

5、浏览器访问 http://ip:8090 进入安装界面,完成安装配置。

6、停止 install 程序,启动 MM-Wiki 系统

cd ..
./mm-wiki --conf conf/mm-wiki.conf

7、浏览器访问监听的 IP 和端口,开始使用 MM-Wiki。

Windows 平台

1、下载最新版本压缩包(以 Windows amd64 为例)

2、手动解压到当前目录

3、进入 install 目录,双击运行 install.exe 文件

4、浏览器访问 http://ip:8090 进入安装界面,完成安装配置

5、关闭 install 窗口,使用命令行工具进入程序根目录

mm-wiki.exe --conf conf/mm-wiki.conf

6、浏览器访问监听的 IP 和端口,开始使用 MM-Wiki。

Docker 部署

数据库准备

导入 docs/databases/data.sqldocs/databases/table.sql(注意:需取消注释 data.sql 中第一条管理用户插入语句)。

部署方式

• DockerHub(推荐)

1、从 DockerHub 下载 v0.1.7 版本

2、新增配置文件,设置数据存放目录及 MySQL 数据库配置在 mm-wiki.conf 文件中

3、挂载配置文件及数据存放目录,启动端口为 8080

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

• 本地构建最新代码

1、构建项目镜像

docker build -t mm-wiki-image .

2、新增配置文件,设置数据存放目录及 MySQL 数据库配置在 mm-wiki.conf 文件中

3、挂载配置文件及数据存放目录,启动端口为 8080

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

如果需要,可用 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;
    }
}

MM-Wiki二次开发

环境要求:Go 1.8

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