一、zyplayer-doc是什麼

zyplayer-doc是一款適合企業和個人使用的WIKI知識庫管理工具，專為私有化部署而設計，最大程度上保證企業或個人的數據安全，支持以內網的方式來部署使用。

支持將編寫的文檔一鍵發佈為企業產品的幫助文檔，支持以單文檔、目錄、空間、文集的方式開放至互聯網，可用於獨立的幫助中心站點，嵌入自有產品、APP、小程序或微信公眾號菜單中用作幫助文檔，或者用於展廳、大屏中滾動播放展示。

系統有開源協議友好的開源版本，源碼完整開放無需任何授權，無任何商業用途的二次開發限制，可高度定製修改。也有功能豐富且完整的商業版本，可直接私有化部署使用，對於個人、開源項目或組織、教育用途完全免費。

二、適用場景

• 企業知識庫： 可用於企業內部知識積累與協作的文檔管理平台，所有修改可追溯，全局內容搜索查找文檔更便捷。雲端管理防止文檔丟失，企業人員流動不會導致企業知識資產的流失。
• 產品幫助文檔： 可將編輯好的文檔一鍵開放給外部訪問，產品文檔的維護和分享更加便捷。可用於獨立的文檔站點，嵌入自有產品、APP、小程序或微信公眾號菜單中用作產品幫助文檔，或者用於展廳、大屏中滾動播放展示。
• 個人筆記與知識庫： 可以私有化部署在自己電腦上或雲端，用作個人的筆記軟件使用，不再擔心個人隱私信息泄露，不再擔心雲服務廠商突然的停服、泄露、收費或倒閉斷供，導致自己長期積累的知識全部丟失。
• 知識分享與博客： 可非常方便的將自己的知識進行公開分享，或者作為自己產品的幫助文檔使用，可實時編輯與發佈生效。也可以當作博客系統來使用，目錄樹的層級模式讓閲讀與查找更加便捷。

三、功能與亮點

• 團隊協作編輯： 完善的權限體系，支持空間、用户、部門、文檔粒度的權限管控，包含管理員、協作者、查看者角色。
• 豐富的編輯器： 支持在線編輯富文本、Markdown、表格、Office文檔、API接口、思維導圖、任意的文本文件等。
• 一鍵對外開放： 支持將文檔以空間、單文檔、文集的方式對外公開，可獨立的站點或URL訪問，也可嵌入自有產品中。
• 空間數據分析： 空間支持訪問趨勢分析、頁面訪問排行、用户活躍排行的數據分析，支持按日周月維度的統計查看。
• 文檔版本控制： 空間和文集支持版本的控制，讓文檔和產品具有版本的對應關係，防止更新後舊版本的文檔無法訪問。
• 文檔導入導出： 系統支持任意格式文件的導入，支持空間整體的導入、導出與複製，支持文檔的跨空間複製與遷移。
• 多種存儲方式： 可使用文件系統、阿里雲OSS、騰訊雲COS、華為雲OBS、MinIO、以及所有支持S3協議的對象存儲。
• 全屏水印管理： 支持內部文檔、開放文檔的全屏水印獨立配置，支持上傳的圖片中添加水印，防止數據泄露與複製。
• 全局內容搜索： 可對知識庫中的內容進行全局自動分詞搜索，包含Word、PPT、Excel、PDF與掃描件、圖片文字搜索。
• 知識庫AI問答： 接入AI產品後可基於知識庫中的內容進行AI問答，AI問答來源安全可控，更加智能的內容搜索體驗。
• 更安全的登錄： 支持常規登錄、LDAP、OAuth2、飛書、釘釘、企業微信賬號體系的登錄，支持雙因素認證與開放註冊。
• 國際化多語言： 具有完善的多語言體系，支持系統級別、用户個人、每個開放空間或文集選擇指定的語言分別展示。
• 文檔付費閲讀： 可快速的接入與開啓開放文檔的付費閲讀功能，無需對接三方支付，可自行定價，讓知識產生價值。
• 系統全局管控： 系統中展示的LOGO、標題、備案信息、主題色、三方驗證接口、全局CSS、網頁代碼均可自行配置。
• 自建組件支持： 支持管理與編輯自定義的Vue組件在文檔內容中渲染並展示，讓文檔的展示內容具有無限的可能。

四、快速部署

軟件的部署比較簡單，安裝必要的JAVA環境依賴和一個MySQL數據庫，去官網下載最新的安裝包，然後修改數據庫配置後執行 ./startup.sh 即可啓動起來，或者使用Docker部署：docker pull zyplayer/zyplayer-doc:latest，也可以使用 1Panel 、寶塔面板、NAS 等方式部署，詳細的部署方法可在官方文檔中查看： https://doc.zyplayer.com

五、功能介紹

1、知識庫管理

知識庫按空間進行劃分，也可對空間進行分組管理，空間可設置為空間成員可見、企業內公開和互聯網公開，具有非常細粒度的組織權限劃分。

空間內可創建和管理不同類型的文檔，如富文本、Markdown、表格、API文檔、Office文檔、思維導圖、本地上傳文件等，有友好的文檔查看頁面和功能豐富的編輯器。

文檔以樹的形式進行管理，支持無限層級的文檔劃分組織，任意節點都可包含子文檔，可對文檔進行收藏置頂展示，支持文檔全文檢索，以空格分割的多關鍵字檢索等，文檔的訪問數據具有統計分析功能，每天凌晨自動彙總前一天、周、月的數據，文檔刪除後可在回收站進行恢復和徹底刪除。

2、公開分享與開放文集

在空間設置頁可將編寫的文檔發佈至互聯網，發佈後獲得鏈接的用户均可訪問該空間內的文檔，可用於企業產品文檔、知識分享等場景使用。

開放文檔具有多種展示主題，可設置密碼訪問、付費閲讀、文檔試讀、動態密碼訪問等，滿足用户絕大部分文檔公開分享的場景使用。

3、豐富的編輯器

具有豐富的文檔編輯類型支持，滿足絕大部分在線文檔編輯、查看、管理的場景，每一種編輯器都經過了長時間的打磨，兼具功能豐富和簡潔美觀的優點。

其中自研的Markdown編輯器除基礎的格式外還支持了VuePress的提示組件、代碼塊高亮、多頁籤組件，還有分欄、卡片、名片、時間線、科學公式、Echarts圖表、思維導圖、流程圖、時序圖、PlantUML圖 等一系列組件，還支持使用Vue編寫更多自建組件使用。

Office文檔支持Word、PPT、Excel、PDF格式文檔的多人在線協同編輯查看，編輯體驗和本地編輯器無異。

API文檔支持接口文檔的在線編輯、調試、公開分享等，作為系統內一種可選的文檔類型，讓API文檔的管理不再獨立和分散，基於內網部署也讓你的API更加安全，可以更放心的編寫內部或對外分享的API接口文檔。

4、內部協作支持

在文檔右上角操作區包含有各種功能操作按鈕，針對單個文檔的查看和管理更加方便快捷。

全屏演示功能可在內部投屏講解時使用，文檔更聚焦，文字也做了更大字號的顯示。評論功能可對文檔整體進行評論、發表意見，附件管理頁可上傳任意格式的文件，便於相關資源的分享與下載，歷史管理頁可查看每次保存的文檔記錄，也可查看或回滾指定的歷史記錄，便於文檔的追溯和還原。

文檔的通知包含了所有修改、評論、點贊等操作，讓文檔所屬者及時掌握文檔的變化。更多菜單裏還包含開放文檔的查看、單個文檔的分享、頁面展示的設置、模板設置、文檔下載和文檔信息等操作按鈕。

5、文檔版本控制

在空間設置頁可開啓版本控制功能，每完成一個版本文檔的編寫即可手動創建一個版本，各版本內的文檔均可獨立管理，用户在查看開放文檔時也可在右上角切換版本查看對應版本的文檔。

6、文檔存儲與安全

系統中圖片或附件的存儲支持文件系統、阿里雲OSS、騰訊雲COS、華為雲OBS、MinIO、以及支持了Amazon S3協議的存儲服務。

系統登錄支持文檔內置登錄、SSO登錄接入，可管理控制賬號的密碼複雜度，登錄安全驗證支持圖形驗證碼、飛書、釘釘、企業微信的安全校驗碼，對於員工賬號的登錄安全做到最可靠的控制。

7、其他功能

支持用户管理、用户權限管理、用户禁用啓用等操作，部門以樹的形式管理，部門可用於空間添加協作部門使用，可開啓用户註冊功能，開啓後用户可自行在註冊頁面通過郵箱註冊賬號使用。

開放文檔均支持開啓付費閲讀，讓你的文檔能產生實際的收入。

支持文檔單頁分享、文檔導出、整個空間文檔的導出、模板管理。

支持文檔訪問數據統計，有昨日數據、訪問趨勢分析、頁面訪問排行、活躍用户排行等一系列統計分析功能。

支持使用Vue編寫自建組件，編寫的組件可在Markdown文檔中直接引用，可添加 iframe 嵌入任意網頁，或是公用的廣告組件等。

開放文檔支持劃詞反饋，便於用户對於你文檔的糾正、反饋和互動。