{"id":13416788,"url":"https://github.com/mindoc-org/mindoc","last_synced_at":"2026-01-23T10:51:56.803Z","repository":{"id":36969693,"uuid":"88705168","full_name":"mindoc-org/mindoc","owner":"mindoc-org","description":"Golang实现的基于beego框架的接口在线文档管理系统","archived":false,"fork":false,"pushed_at":"2026-01-19T12:03:15.000Z","size":93798,"stargazers_count":7806,"open_issues_count":324,"forks_count":1985,"subscribers_count":269,"default_branch":"master","last_synced_at":"2026-01-19T18:52:41.766Z","etag":null,"topics":["beego","document","go","golang","mindoc","smartwiki"],"latest_commit_sha":null,"homepage":"https://doc.gsw945.com/docs/mindoc-docs","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mindoc-org.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-04-19T05:37:46.000Z","updated_at":"2026-01-15T00:19:34.000Z","dependencies_parsed_at":"2023-02-15T21:15:22.032Z","dependency_job_id":"b25a9a99-a7c4-4179-b58c-9b5815178d3f","html_url":"https://github.com/mindoc-org/mindoc","commit_stats":{"total_commits":849,"total_committers":38,"mean_commits":"22.342105263157894","dds":"0.25795053003533563","last_synced_commit":"5f3b2fa1ef48420dde0186d4fbdddc9823649713"},"previous_names":["lifei6671/mindoc"],"tags_count":38,"template":false,"template_full_name":null,"purl":"pkg:github/mindoc-org/mindoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mindoc-org%2Fmindoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mindoc-org%2Fmindoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mindoc-org%2Fmindoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mindoc-org%2Fmindoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mindoc-org","download_url":"https://codeload.github.com/mindoc-org/mindoc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mindoc-org%2Fmindoc/sbom","scorecard":{"id":588838,"data":{"date":"2025-08-11","repo":{"name":"github.com/mindoc-org/mindoc","commit":"d0cfdf21eef6d367062bd10f1d38ad727f5ec80f"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.3,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":9,"reason":"Found 28/30 approved changesets -- score normalized to 9","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/build.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.md:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE.md:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v2.2-beta.1 not signed: https://api.github.com/repos/mindoc-org/mindoc/releases/118322366","Warn: release artifact v2.1 not signed: https://api.github.com/repos/mindoc-org/mindoc/releases/72401597","Warn: release artifact v2.1-beta.6 not signed: https://api.github.com/repos/mindoc-org/mindoc/releases/66760252","Warn: release artifact v2.1-beta.5 not signed: https://api.github.com/repos/mindoc-org/mindoc/releases/51409458","Warn: release artifact v2.1-beta.1 not signed: https://api.github.com/repos/mindoc-org/mindoc/releases/45463754","Warn: release artifact v2.2-beta.1 does not have provenance: https://api.github.com/repos/mindoc-org/mindoc/releases/118322366","Warn: release artifact v2.1 does not have provenance: https://api.github.com/repos/mindoc-org/mindoc/releases/72401597","Warn: release artifact v2.1-beta.6 does not have provenance: https://api.github.com/repos/mindoc-org/mindoc/releases/66760252","Warn: release artifact v2.1-beta.5 does not have provenance: https://api.github.com/repos/mindoc-org/mindoc/releases/51409458","Warn: release artifact v2.1-beta.1 does not have provenance: https://api.github.com/repos/mindoc-org/mindoc/releases/45463754"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 28 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/mindoc-org/mindoc/build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/mindoc-org/mindoc/build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/mindoc-org/mindoc/build.yml/master?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:1","Warn: containerImage not pinned by hash: Dockerfile:34: pin your Docker image by updating ubuntu:latest to ubuntu:latest@sha256:7c06e91f61fa88c08cc74f7e1b7c69ae24910d745357e0dfe1d2c0322aaf20f9","Info:   0 out of   3 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Vulnerabilities","score":0,"reason":"45 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GO-2024-3016 / GHSA-r6qh-j42j-pw64","Warn: Project is vulnerable to: GHSA-wr3p-r5fj-wf97","Warn: Project is vulnerable to: GO-2024-3331 / GHSA-9j3m-fr7q-jxfw","Warn: Project is vulnerable to: GO-2025-3585 / GHSA-2j42-h78h-q4fg","Warn: Project is vulnerable to: GO-2023-2402 / GHSA-45x7-px36-x8w8","Warn: Project is vulnerable to: GO-2024-3321 / GHSA-v778-237x-gjrc","Warn: Project is vulnerable to: GO-2025-3487 / GHSA-hcg3-q754-cr77","Warn: Project is vulnerable to: GO-2023-1990 / GHSA-j3p8-6mrq-6g7h","Warn: Project is vulnerable to: GO-2023-1989 / GHSA-x92r-3vfx-4cv3","Warn: Project is vulnerable to: GO-2024-2937 / GHSA-9phm-fm57-rhg8","Warn: Project is vulnerable to: GO-2023-1988 / GHSA-2wrh-6pvc-2jm9","Warn: Project is vulnerable to: GO-2023-2102 / GHSA-4374-p667-p6c8","Warn: Project is vulnerable to: GHSA-qppj-fm5r-hxr3","Warn: Project is vulnerable to: GO-2024-2687 / GHSA-4v7x-pqxf-cx7m","Warn: Project is vulnerable to: GO-2024-3333","Warn: Project is vulnerable to: GO-2025-3503 / GHSA-qxp5-gwg8-xv66","Warn: Project is vulnerable to: GO-2025-3595 / GHSA-vvgc-356p-c3xw","Warn: Project is vulnerable to: GO-2024-2611 / GHSA-8r3f-844c-mc37","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx","Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-434g-2637-qmqr","Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m","Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw","Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p","Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747","Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh","Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6","Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx","Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94","Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-20T21:18:36.371Z","repository_id":36969693,"created_at":"2025-08-20T21:18:36.371Z","updated_at":"2025-08-20T21:18:36.371Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28689076,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T05:48:07.525Z","status":"ssl_error","status_checked_at":"2026-01-23T05:48:07.129Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["beego","document","go","golang","mindoc","smartwiki"],"created_at":"2024-07-30T22:00:22.137Z","updated_at":"2026-01-23T10:51:56.797Z","avatar_url":"https://github.com/mindoc-org.png","language":"Go","readme":"# MinDoc 简介\n\n[![Build Status](https://travis-ci.com/mindoc-org/mindoc.svg?branch=master)](https://travis-ci.com/mindoc-org/mindoc)\n[![Build status](https://ci.appveyor.com/api/projects/status/7680ia6mu29m12wx?svg=true)](https://ci.appveyor.com/project/mindoc-org/mindoc)\n\nMinDoc 是一款针对IT团队开发的简单好用的文档管理系统。\n\nMinDoc 的前身是 [SmartWiki](https://github.com/lifei6671/SmartWiki) 文档系统。SmartWiki 是基于 PHP 框架 laravel 开发的一款文档管理系统。因 PHP 的部署对普通用户来说太复杂，所以改用 Golang 开发。可以方便用户部署和实用。\n\n开发缘起是公司IT部门需要一款简单实用的项目接口文档管理和分享的系统。其功能和界面源于 kancloud 。\n\n可以用来储存日常接口文档，数据库字典，手册说明等文档。内置项目管理，用户管理，权限管理等功能，能够满足大部分中小团队的文档管理需求。\n\n##### 演示站点\u0026文档:\n- https://demo.mindoc.cn/docs/mindochelp\n- https://www.iminho.me/wiki/docs/mindoc/\n- https://doc.gsw945.com/docs/mindoc-docs/\n\n---\n\n### 开发\u0026维护\u0026使用 悉知\n\n- 感谢作者 [lifei6671](https://github.com/lifei6671) 创造了MinDoc，并持续维护了很久。\n- 作者因工作等原因，精力有限，无法花费足够的时间来持续维护mindoc，已于北京时间2021年3月23日将mindoc交给社区(github组织[mindoc-org](https://github.com/mindoc-org))维护，期待热心开发者加入[mindoc-org](https://github.com/mindoc-org)一起来维护MinDoc。\n- 遇到问题请提 [Issues](https://github.com/mindoc-org/mindoc/issues )，欢迎使用者和贡献者加入QQ群 `1051164153`\n\u003ca target=\"_blank\" href=\"https://qm.qq.com/cgi-bin/qm/qr?k=bHFR7P3Qp1nsSPbsTw4KN_ZpFLUAblIU\u0026jump_from=webapi\"\u003e\u003cimg border=\"0\" src=\"https://pub.idqqimg.com/wpa/images/group.png\" alt=\"MinDoc使用\u0026amp;开发交流群\" title=\"MinDoc使用\u0026amp;开发交流群\"\u003e\u003c/a\u003e\n- 对开发感兴趣请关注 [Development](https://github.com/mindoc-org/mindoc/projects/1):\n  - [Todo List](https://github.com/mindoc-org/mindoc/projects/1#column-13554511)\n  - [Work in progress](https://github.com/mindoc-org/mindoc/projects/1#column-13554512)\n  - [Review in progress](https://github.com/mindoc-org/mindoc/projects/1#column-13554513)\n- Mindoc基于 [beeego](https://github.com/beego/beego) 开发，beego文档地址: https://github.com/beego/beego-doc/tree/main/docs/zh\n- :warning: **特别声明**:\n  - 原作者 [lifei6671](https://github.com/lifei6671) 已于 2021-08-06 删除了个人捐赠信息，参见: [1a179179c1fe4d0d4db95e0b757d863aee5bf395](https://github.com/mindoc-org/mindoc/commit/1a179179c1fe4d0d4db95e0b757d863aee5bf395)\n  - 截止目前(2023-03-27)，[mindoc-org](https://github.com/mindoc-org) 暂未发布任何捐赠信息，请勿轻信\n\n---\n\n# 安装与使用\n\n~~如果你的服务器上没有安装golang程序请手动设置一个环境变量如下：键名为 ZONEINFO，值为MinDoc跟目录下的/lib/time/zoneinfo.zip 。~~\n\n更多信息请查看手册： [MinDoc 使用手册](https://demo.mindoc.cn/docs/mindochelp/mindoc-summary)\n\n对于没有Golang使用经验的用户，可以从 [https://github.com/mindoc-org/mindoc/releases](https://github.com/mindoc-org/mindoc/releases) 这里下载编译完的程序。\n\n如果有Golang开发经验，建议通过编译安装，要求golang版本不小于1.23.0(需支持`CGO`、`go mod`和`import _ \"time/tzdata\"`)(推荐Go版本为1.23.x)。\n\u003e 注意: CentOS7上GLibC版本低，常规编译版本不能使用。需要自行源码编译,或使用使用musl编译版本。\n\n## 常规编译\n```bash\n# 克隆源码\ngit clone https://github.com/mindoc-org/mindoc.git\n# go包安装\ngo mod tidy -v\n# 编译(sqlite需要CGO支持)\ngo build -ldflags \"-w\" -o mindoc main.go\n# 数据库初始化(此步骤执行之前，需配置`conf/app.conf`)\n./mindoc install\n# 执行\n./mindoc\n# 开发阶段运行\nbee run\n```\n\n## 旧版本运行 可更新部分数据库配置\n```base\n./mindoc update\n```\n\nMinDoc 如果使用MySQL储存数据，则编码必须是`utf8mb4_general_ci`。请在安装前，把数据库配置填充到项目目录下的 `conf/app.conf` 中。\n\n如果使用 `SQLite` 数据库，则直接在配置文件中配置数据库路径即可.\n\n如果conf目录下不存在 `app.conf` 请重命名 `app.conf.example` 为 `app.conf`。\n\n**默认程序会自动初始化一个超级管理员用户：admin 密码：123456 。请登录后重新设置密码。**\n\n## Linux系统中不依赖gLibC的编译方式\n\n### 安装 musl-gcc\n```bash\n# 手动安装\nwget -c http://musl.libc.org/releases/musl-1.2.2.tar.gz\ntar -xvf musl-1.2.2.tar.gz\ncd musl-1.2.2\n./configure\nmake\nsudo make install\n# apt 安装\nsudo apt install musl-tools\n```\n\n\n### 使用 musl-gcc 编译 mindoc\n```bash\ngo mod tidy -v\nexport GOARCH=amd64\nexport GOOS=linux\n# 设置使用musl-gcc\nexport CC=/usr/local/musl/bin/musl-gcc\n# 设置版本\nexport TRAVIS_TAG=temp-musl-v`date +%y%m%d`\ngo build -v -o mindoc_linux_musl_amd64 -ldflags=\"-linkmode external -extldflags '-static' -w -X 'github.com/mindoc-org/mindoc/conf.VERSION=$TRAVIS_TAG' -X 'github.com/mindoc-org/mindoc/conf.BUILD_TIME=`date`' -X 'github.com/mindoc-org/mindoc/conf.GO_VERSION=`go version`'\"\n# 验证\n./mindoc_linux_musl_amd64 version\n```\n\n## Windows 上后台运行\n 使用 [mindoc-daemon](https://github.com/mindoc-org/mindoc-daemon)\n\n\n```ini\n#邮件配置-示例\n#是否启用邮件\nenable_mail=true\n#smtp服务器的账号\nsmtp_user_name=admin@iminho.me\n#smtp服务器的地址\nsmtp_host=smtp.ym.163.com\n#密码\nsmtp_password=1q2w3e__ABC\n#端口号\nsmtp_port=25\n#邮件发送人的地址\nform_user_name=admin@iminho.me\n#邮件有效期30分钟\nmail_expired=30\n```\n\n\n# 使用Docker部署\n如果是Docker用户，可参考项目内置的Dockerfile文件自行编译镜像(编译命令见Dockerfile文件底部注释，仅供参考)。\n\n在启动镜像时需要提供如下的常用环境变量(全部支持的环境变量请参考: [`conf/app.conf.example`](https://github.com/mindoc-org/mindoc/blob/master/conf/app.conf.example))：\n```ini\nDB_ADAPTER                  指定DB类型(默认为sqlite)\nMYSQL_PORT_3306_TCP_ADDR    MySQL地址\nMYSQL_PORT_3306_TCP_PORT    MySQL端口号\nMYSQL_INSTANCE_NAME         MySQL数据库名称\nMYSQL_USERNAME              MySQL账号\nMYSQL_PASSWORD              MySQL密码\nHTTP_PORT                   程序监听的端口号\nMINDOC_ENABLE_EXPORT        开启导出(默认为false)\n```\n\n#### 举个栗子-当前(公开)镜像(信息页面: https://cr.console.aliyun.com/images/cn-hangzhou/mindoc-org/mindoc/detail , 需要登录阿里云账号才可访问列表)\n##### Windows\n```bash\nset MINDOC=//d/mindoc\ndocker run -it --name=mindoc --restart=always -v \"%MINDOC%/conf\":\"/mindoc/conf\" -p 8181:8181 -e MINDOC_ENABLE_EXPORT=true -d registry.cn-hangzhou.aliyuncs.com/mindoc-org/mindoc:v2.2-beta.2\n```\n\n##### Linux、Mac\n```bash\nexport MINDOC=/home/ubuntu/mindoc-docker\ndocker run -it --name=mindoc --restart=always -v \"${MINDOC}/conf\":\"/mindoc/conf\" -p 8181:8181 -e MINDOC_ENABLE_EXPORT=true -d registry.cn-hangzhou.aliyuncs.com/mindoc-org/mindoc:v2.2-beta.2\n```\n\n##### 举个栗子-更多环境变量示例(镜像已过期，仅供参考，请以当前镜像为准)\n```bash\ndocker run -p 8181:8181 --name mindoc -e DB_ADAPTER=mysql -e MYSQL_PORT_3306_TCP_ADDR=10.xxx.xxx.xxx -e MYSQL_PORT_3306_TCP_PORT=3306 -e MYSQL_INSTANCE_NAME=mindoc -e MYSQL_USERNAME=root -e MYSQL_PASSWORD=123456 -e httpport=8181 -d daocloud.io/lifei6671/mindoc:latest\n```\n\n#### dockerfile内容参考\n- [无需代理直接加速各种 GitHub 资源拉取 | 国内镜像赋能 | 助力开发](https://blog.frytea.com/archives/504/)\n- [阿里云 - Ubuntu 镜像](https://developer.aliyun.com/mirror/ubuntu)\n\n### docker-compose 一键安装\n\n1. 修改配置文件\n    修改`docker-compose.yml`中的配置信息，主要修改`volumes`节点，将宿主机的两个目录映射到容器内。\n    `environment`节点，配置自己的环境变量。\n    \n2. 一键完成所有环境搭建\n    \n    \u003e docker-compose up -d\n3. 浏览器访问\n    \u003e http://localhost:8181/\n\n    整个部署完成了\n4. 常用命令参考\n   - 启动\n        \n        \u003e docker-compose up -d\n   - 停止\n        \n        \u003e docker-compose stop\n   - 重启\n        \n        \u003e docker-compose restart\n   - 停止删除容器，释放所有资源\n        \n        \u003e docker-compose down\n   - 删除并重新创建\n        \u003e docker-compose -f docker-compose.yml down \u0026\u0026 docker-compose up -d\n        \u003e \n        \u003e 更多 docker-compose 的使用相关的内容 请查看官网文档或百度\n   \n#### MCP服务器对接指导\n1. 请在配置文件中启用MCP服务器功能\n在配置文件`app.conf`中添加或修改为如下内容：\n```\n# MCP Server 功能\nenable_mcp_server=\"${MINDOC_ENABLE_MCP_SERVER||true}\"\nmcp_api_key=\"${MINDOC_MCP_API_KEY||demo-mcp-api-key}\"\n```\n说明：\n`enable_mcp_server`为是否启用MCP服务器功能，默认为true。\n`mcp_api_key` 为MCP服务器的API密钥，示例配置中默认为`demo-mcp-api-key`，可根据需求自行修改。\n\n2. 在Dify等AI应用或其他可调用MCP服务器的项目配置中添加如下Mindoc配置\n```json\n{\n  \"mindoc\": {\n    \"transport\": \"streamable_http\",\n    \"url\": \"http://127.0.0.1:8181/mcp/?api_key=demo-mcp-api-key\",\n    \"headers\":{},\n    \"timeout\":600\n  }\n}\n```\n说明：\n`transport`为传输方式，目前支持`streamable_http`。\n`url`为Mindoc的MCP服务地址，示例配置中Endpoint默认为`http://127.0.0.1:8181`，默认的API密钥为`demo-mcp-api-key`，可自行修改为对接时项目实际使用的Endpoint和API密钥。\n\n# 项目截图\n\n**创建项目**\n\n![创建项目](https://github.com/mindoc-org/mindoc/blob/master/uploads/docs/create.png?raw=true)\n\n**项目列表**\n\n![项目列表](https://github.com/mindoc-org/mindoc/blob/master/uploads/docs/project_list.png?raw=true)\n\n**项目概述**\n\n![项目概述](https://github.com/mindoc-org/mindoc/blob/master/uploads/docs/intro.png?raw=true)\n\n**项目成员**\n\n![项目成员](https://github.com/mindoc-org/mindoc/blob/master/uploads/docs/member.png?raw=true)\n\n**项目设置**\n\n![项目设置](https://github.com/mindoc-org/mindoc/blob/master/uploads/docs/project_setting.png?raw=true)\n\n**基于Editor.md开发的Markdown编辑器**\n\n![基于Editor.md开发的Markdown编辑器](https://github.com/mindoc-org/mindoc/blob/master/uploads/docs/editor_md.png?raw=true)\n\n**基于wangEditor开发的富文本编辑器**\n\n![基于wangEditor开发的富文本编辑器](https://github.com/mindoc-org/mindoc/blob/master/uploads/docs/wang_editor.png?raw=true)\n\n\n**基于cherryMarkdown开发的编辑器**\n\n![基于cherry-markdown开发的编辑器](https://github.com/mindoc-org/mindoc/blob/master/uploads/docs/cheery-markdown.png?raw=true)\n\n**项目预览**\n\n![项目预览](https://github.com/mindoc-org/mindoc/blob/master/uploads/docs/preview.png?raw=true)\n\n**超级管理员后台**\n\n![超级管理员后台](https://github.com/mindoc-org/mindoc/blob/master/uploads/docs/admin.png?raw=true)\n\n\n# 使用的技术(TODO: 最新技术栈整理中，使用的第三方库升级中)\n\n- [Beego](https://github.com/beego/beego) ~~1.10.0~~\n- MySQL 5.6\n- [editor.md](https://github.com/pandao/editor.md) Markdown 编辑器\n- [cherry-markdown](https://github.com/Tencent/cherry-markdown) Cherry Markdown Writer\n- [Bootstrap](https://github.com/twbs/bootstrap) 3.2\n- [jQuery](https://github.com/jquery/jquery) 库\n- [WebUploader](https://github.com/fex-team/webuploader) 文件上传框架\n- [NProgress](https://github.com/rstacruz/nprogress) 库\n- [jsTree](https://github.com/vakata/jstree) 树状结构库\n- [Font Awesome](https://github.com/FortAwesome/Font-Awesome) 字体库\n- [Cropper](https://github.com/fengyuanchen/cropper) 图片剪裁库\n- [layer](https://github.com/sentsin/layer) 弹出层框架\n- [highlight.js](https://github.com/highlightjs/highlight.js) 代码高亮库\n- ~~to-markdown~~[Turndown](https://github.com/domchristie/turndown) HTML转Markdown库\n- ~~quill 富文本编辑器~~\n- [wangEditor](https://github.com/wangeditor-team/wangEditor) 富文本编辑器\n  - 参考\n    - [wangEditor v4.7 富文本编辑器教程](https://www.bookstack.cn/books/wangeditor-4.7-zh)\n    - [扩展菜单注册太过繁琐 #2493](https://github.com/wangeditor-team/wangEditor/issues/2493)\n  - 工具： `https://babeljs.io/repl` + `@babel/plugin-transform-classes`\n- [Vue.js](https://github.com/vuejs/vue) 框架\n- [MCP-Go](https://github.com/mark3labs/mcp-go)\n\n\n# 主要功能\n\n- 项目管理，可以对项目进行编辑更改，成员添加, 项目排序等。\n- 文档管理，添加和删除文档等。\n- 评论管理，可以管理文档评论和自己发布的评论。\n- 用户管理，添加和禁用用户，个人资料更改等。\n- 用户权限管理 ， 实现用户角色的变更。\n- 项目加密，可以设置项目公开状态，私有项目需要通过Token访问。\n- 站点配置，多语言切换, 可开启匿名访问、验证码等。\n\n# 参与开发\n\n我们欢迎您在 MinDoc 项目的 GitHub 上报告 issue 或者 pull request。\n\n如果您还不熟悉GitHub的Fork and Pull开发模式，您可以阅读GitHub的文档（https://help.github.com/articles/using-pull-requests） 获得更多的信息。\n\n# 关于作者[lifei6671](https://github.com/lifei6671)\n\n一个不纯粹的PHPer，一个不自由的 gopher 。\n\n\n# 部署补充\n- 若内网部署，draw.io无法使用外网，则需要用tomcat运行war包，见（https://github.com/jgraph/drawio） 从release下载，之后修改markdown.js的TODO行对应的链接即可\n- 为了护眼，简单增加了编辑界面的主题切换，见editormd.js和markdown_edit_template.tpl\n- (需重新编译项)为了对已删除文档/文档引用图片删除文字后，对悬空无引用的图片/附件进行清理，增加了清理接口，需重新编译\n     - 编译后除二进制文件外还需更新三个文件: conf/lang/en-us.ini,zh-cn.ini; attach_list.tpl\n     - 若不想重新编译，也可通过database/clean.py，手动执行对无引用图片/附件的文件清理和数据库记录双向清理。\n- 若采用nginx二级部署，以yourpath/为例，需修改\n     - conf/app.conf修改：`baseurl=\"/yourpath\"`\n     - static/js/kancloud.js文件中`url: \"/comment/xxxxx` =\u003e `url: \"/yourpath\" + \"/comment/xxxxx`, 共两处\n\n     - nginx端口代理示例:\n     ```\n     增加\n     location  /yourpath/ {\n          rewrite ^/yourpath/(.*) /$1  break;\n          proxy_pass http://127.0.0.1:8181;\n     }\n     ```\n     注意使用的是127.0.0.1，根据自身选择替换，如果nginx是docker部署，则还需要在docker中托管运行mindoc，具体参考如下配置:\n     - docker-compose代理示例(docker-nginx代理运行mindoc)\n     ```\n     version: '3'\n     services:\n       mynginx:\n       image: nginx:latest\n       ports:\n         - \"8880:80\"\n       command: \n         - bash\n         - -c\n         - |\n             service nginx start\n             cd /src/mindoc/ \u0026\u0026 ./mindoc\n       volumes:\n         - ..:/src\n         - ./nginx:/etc/nginx/conf.d\n     ```\n\n     目录结构\n     ```\n     onefolder\n     |\n       - docker\n       |\n         - docker-compose.yml\n         - nginx\n         |\n           - mynginx.conf\n       \n       - mindoc\n       |\n         - database/\n         - conf/\n         - ...\n     ```\n","funding_links":[],"categories":["Popular","Go","Repositories","置顶","golang"],"sub_categories":["06、企业协作平台"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmindoc-org%2Fmindoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmindoc-org%2Fmindoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmindoc-org%2Fmindoc/lists"}