一、zyplayer-doc是什么
zyplayer-doc是一款適合企業(yè)和個人使用的WIKI知識庫管理工具，專為私有化部署而設(shè)計，最大程度上保證企業(yè)或個人的數(shù)據(jù)安全，支持以內(nèi)網(wǎng)的方式來部署使用。
支持將編寫的文檔一鍵發(fā)布為企業(yè)產(chǎn)品的幫助文檔，支持以單文檔、目錄、空間、文集的方式開放至互聯(lián)網(wǎng)，可用于獨(dú)立的幫助中心站點(diǎn)，嵌入自有產(chǎn)品、APP、小程序或微信公眾號菜單中用作幫助文檔，或者用于展廳、大屏中滾動播放展示。
系統(tǒng)有開源協(xié)議友好的開源版本，源碼完整開放無需任何授權(quán)，無任何商業(yè)用途的二次開發(fā)限制，可高度定制修改。也有功能豐富且完整的商業(yè)版本，可直接私有化部署使用，對于個人、開源項目或組織、教育用途完全免費(fèi)。
二、適用場景
企業(yè)知識庫： 可用于企業(yè)內(nèi)部知識積累與協(xié)作的文檔管理平臺，所有修改可追溯，全局內(nèi)容搜索查找文檔更便捷。云端管理防止文檔丟失，企業(yè)人員流動不會導(dǎo)致企業(yè)知識資產(chǎn)的流失。
產(chǎn)品幫助文檔： 可將編輯好的文檔一鍵開放給外部訪問，產(chǎn)品文檔的維護(hù)和分享更加便捷。可用于獨(dú)立的文檔站點(diǎn)，嵌入自有產(chǎn)品、APP、小程序或微信公眾號菜單中用作產(chǎn)品幫助文檔，或者用于展廳、大屏中滾動播放展示。
個人筆記與知識庫： 可以私有化部署在自己電腦上或云端，用作個人的筆記軟件使用，不再擔(dān)心個人隱私信息泄露，不再擔(dān)心云服務(wù)廠商突然的停服、泄露、收費(fèi)或倒閉斷供，導(dǎo)致自己長期積累的知識全部丟失。
知識分享與博客： 可非常方便的將自己的知識進(jìn)行公開分享，或者作為自己產(chǎn)品的幫助文檔使用，可實時編輯與發(fā)布生效。也可以當(dāng)作博客系統(tǒng)來使用，目錄樹的層級模式讓閱讀與查找更加便捷。
三、功能與亮點(diǎn)
團(tuán)隊協(xié)作編輯： 完善的權(quán)限體系，支持空間、用戶、部門、文檔粒度的權(quán)限管控，包含管理員、協(xié)作者、查看者角色。
豐富的編輯器： 支持在線編輯富文本、Markdown、表格、Office文檔、API接口、思維導(dǎo)圖、任意的文本文件等。
一鍵對外開放： 支持將文檔以空間、單文檔、文集的方式對外公開，可獨(dú)立的站點(diǎn)或URL訪問，也可嵌入自有產(chǎn)品中。
空間數(shù)據(jù)分析： 空間支持訪問趨勢分析、頁面訪問排行、用戶活躍排行的數(shù)據(jù)分析，支持按日周月維度的統(tǒng)計查看。
文檔版本控制： 空間和文集支持版本的控制，讓文檔和產(chǎn)品具有版本的對應(yīng)關(guān)系，防止更新后舊版本的文檔無法訪問。
文檔導(dǎo)入導(dǎo)出： 系統(tǒng)支持任意格式文件的導(dǎo)入，支持空間整體的導(dǎo)入、導(dǎo)出與復(fù)制，支持文檔的跨空間復(fù)制與遷移。
多種存儲方式： 可使用文件系統(tǒng)、阿里云OSS、騰訊云COS、華為云OBS、MinIO、以及所有支持S3協(xié)議的對象存儲。
全屏水印管理： 支持內(nèi)部文檔、開放文檔的全屏水印獨(dú)立配置，支持上傳的圖片中添加水印，防止數(shù)據(jù)泄露與復(fù)制。
全局內(nèi)容搜索： 可對知識庫中的內(nèi)容進(jìn)行全局自動分詞搜索，包含Word、PPT、Excel、PDF與掃描件、圖片文字搜索。
知識庫AI問答： 接入AI產(chǎn)品后可基于知識庫中的內(nèi)容進(jìn)行AI問答，AI問答來源安全可控，更加智能的內(nèi)容搜索體驗。
更安全的登錄： 支持常規(guī)登錄、LDAP、OAuth2、飛書、釘釘、企業(yè)微信賬號體系的登錄，支持雙因素認(rèn)證與開放注冊。
國際化多語言： 具有完善的多語言體系，支持系統(tǒng)級別、用戶個人、每個開放空間或文集選擇指定的語言分別展示。
文檔付費(fèi)閱讀： 可快速的接入與開啟開放文檔的付費(fèi)閱讀功能，無需對接三方支付，可自行定價，讓知識產(chǎn)生價值。
系統(tǒng)全局管控： 系統(tǒng)中展示的LOGO、標(biāo)題、備案信息、主題色、三方驗證接口、全局CSS、網(wǎng)頁代碼均可自行配置。
自建組件支持： 支持管理與編輯自定義的Vue組件在文檔內(nèi)容中渲染并展示，讓文檔的展示內(nèi)容具有無限的可能。
四、快速部署
軟件的部署比較簡單，安裝必要的JAVA環(huán)境依賴和一個MySQL數(shù)據(jù)庫，去官網(wǎng)下載最新的安裝包，然后修改數(shù)據(jù)庫配置后執(zhí)行 ./startup.sh 即可啟動起來，或者使用Docker部署：docker pull zyplayer/zyplayer-doc:latest，也可以使用 1Panel 、寶塔面板、NAS 等方式部署，詳細(xì)的部署方法可在官方文檔中查看： https://doc.zyplayer.com
五、功能介紹
1、知識庫管理
知識庫按空間進(jìn)行劃分，也可對空間進(jìn)行分組管理，空間可設(shè)置為空間成員可見、企業(yè)內(nèi)公開和互聯(lián)網(wǎng)公開，具有非常細(xì)粒度的組織權(quán)限劃分。
空間內(nèi)可創(chuàng)建和管理不同類型的文檔，如富文本、Markdown、表格、API文檔、Office文檔、思維導(dǎo)圖、本地上傳文件等，有友好的文檔查看頁面和功能豐富的編輯器。
文檔以樹的形式進(jìn)行管理，支持無限層級的文檔劃分組織，任意節(jié)點(diǎn)都可包含子文檔，可對文檔進(jìn)行收藏置頂展示，支持文檔全文檢索，以空格分割的多關(guān)鍵字檢索等，文檔的訪問數(shù)據(jù)具有統(tǒng)計分析功能，每天凌晨自動匯總前一天、周、月的數(shù)據(jù)，文檔刪除后可在回收站進(jìn)行恢復(fù)和徹底刪除。
[圖片上傳失敗...(image-53a9b9-1721723529466)]
[圖片上傳失敗...(image-41ace1-1721723529466)]
2、公開分享與開放文集
在空間設(shè)置頁可將編寫的文檔發(fā)布至互聯(lián)網(wǎng)，發(fā)布后獲得鏈接的用戶均可訪問該空間內(nèi)的文檔，可用于企業(yè)產(chǎn)品文檔、知識分享等場景使用。
開放文檔具有多種展示主題，可設(shè)置密碼訪問、付費(fèi)閱讀、文檔試讀、動態(tài)密碼訪問等，滿足用戶絕大部分文檔公開分享的場景使用。
[圖片上傳失敗...(image-ed5b9d-1721723529466)]
3、豐富的編輯器
具有豐富的文檔編輯類型支持，滿足絕大部分在線文檔編輯、查看、管理的場景，每一種編輯器都經(jīng)過了長時間的打磨，兼具功能豐富和簡潔美觀的優(yōu)點(diǎn)。
其中自研的Markdown編輯器除基礎(chǔ)的格式外還支持了VuePress的提示組件、代碼塊高亮、多頁簽組件，還有分欄、卡片、名片、時間線、科學(xué)公式、Echarts圖表、思維導(dǎo)圖、流程圖、時序圖、PlantUML圖 等一系列組件，還支持使用Vue編寫更多自建組件使用。
Office文檔支持Word、PPT、Excel、PDF格式文檔的多人在線協(xié)同編輯查看，編輯體驗和本地編輯器無異。
API文檔支持接口文檔的在線編輯、調(diào)試、公開分享等，作為系統(tǒng)內(nèi)一種可選的文檔類型，讓API文檔的管理不再獨(dú)立和分散，基于內(nèi)網(wǎng)部署也讓你的API更加安全，可以更放心的編寫內(nèi)部或?qū)ν夥窒淼腁PI接口文檔。
[圖片上傳失敗...(image-5922d-1721723529466)]
4、內(nèi)部協(xié)作支持
在文檔右上角操作區(qū)包含有各種功能操作按鈕，針對單個文檔的查看和管理更加方便快捷。
全屏演示功能可在內(nèi)部投屏講解時使用，文檔更聚焦，文字也做了更大字號的顯示。評論功能可對文檔整體進(jìn)行評論、發(fā)表意見，附件管理頁可上傳任意格式的文件，便于相關(guān)資源的分享與下載，歷史管理頁可查看每次保存的文檔記錄，也可查看或回滾指定的歷史記錄，便于文檔的追溯和還原。
文檔的通知包含了所有修改、評論、點(diǎn)贊等操作，讓文檔所屬者及時掌握文檔的變化。更多菜單里還包含開放文檔的查看、單個文檔的分享、頁面展示的設(shè)置、模板設(shè)置、文檔下載和文檔信息等操作按鈕。
[圖片上傳失敗...(image-bda778-1721723529466)]
5、文檔版本控制
在空間設(shè)置頁可開啟版本控制功能，每完成一個版本文檔的編寫即可手動創(chuàng)建一個版本，各版本內(nèi)的文檔均可獨(dú)立管理，用戶在查看開放文檔時也可在右上角切換版本查看對應(yīng)版本的文檔。
[圖片上傳失敗...(image-f7092e-1721723529466)]
[圖片上傳失敗...(image-5febda-1721723529466)]
6、文檔存儲與安全
系統(tǒng)中圖片或附件的存儲支持文件系統(tǒng)、阿里云OSS、騰訊云COS、華為云OBS、MinIO、以及支持了Amazon S3協(xié)議的存儲服務(wù)。
系統(tǒng)登錄支持文檔內(nèi)置登錄、SSO登錄接入，可管理控制賬號的密碼復(fù)雜度，登錄安全驗證支持圖形驗證碼、飛書、釘釘、企業(yè)微信的安全校驗碼，對于員工賬號的登錄安全做到最可靠的控制。
[圖片上傳失敗...(image-3bfd61-1721723529466)]
[圖片上傳失敗...(image-934a8f-1721723529466)]
7、其他功能
支持用戶管理、用戶權(quán)限管理、用戶禁用啟用等操作，部門以樹的形式管理，部門可用于空間添加協(xié)作部門使用，可開啟用戶注冊功能，開啟后用戶可自行在注冊頁面通過郵箱注冊賬號使用。
開放文檔均支持開啟付費(fèi)閱讀，讓你的文檔能產(chǎn)生實際的收入。
支持文檔單頁分享、文檔導(dǎo)出、整個空間文檔的導(dǎo)出、模板管理。
支持文檔訪問數(shù)據(jù)統(tǒng)計，有昨日數(shù)據(jù)、訪問趨勢分析、頁面訪問排行、活躍用戶排行等一系列統(tǒng)計分析功能。
支持使用Vue編寫自建組件，編寫的組件可在Markdown文檔中直接引用，可添加 iframe 嵌入任意網(wǎng)頁，或是公用的廣告組件等。
開放文檔支持劃詞反饋，便于用戶對于你文檔的糾正、反饋和互動。
[圖片上傳失敗...(image-757e41-1721723529466)]
