1. Project Overview

zyplayer-doc

An Online Knowledge Base Management Platform Focused on Self-Hosted Deployment

zyplayer-doc is a WIKI documentation management tool suitable for self-hosted deployment by teams and individuals. It also includes modules for database management and API management.

Suitable as a knowledge base, note-taking, and document management tool for companies or individuals. Documents can be published in publicly accessible formats and used as company product documentation, help documentation, and more.

2. Open Source License

Licensed under Apache-2.0

3. Screenshots

Interface Preview

Console Page 

WIKI Documentation Page 

Standard Edition Interface Preview

Source: zyplayer-doc Official Website

4. Feature Overview

zyplayer-doc is a knowledge base and WIKI document management system focused on self-hosted deployment for individuals and enterprises. Its extensive features meet almost all enterprise document management requirements.

Secure and Controllable Data

Data security comes first. We focus on providing self-hosted document management systems, ensuring that your data always remains under your control.

Rich Editing Capabilities

Supports online editing of rich text, Markdown, tables, Office documents, API interfaces, mind maps, and arbitrary text files.

Collaborative Team Editing

A comprehensive permission system supporting access control at the space, user, department, and document levels, with Administrator, Collaborator, and Viewer roles.

Multiple Login Methods

Supports standard login, LDAP, OAuth2, Feishu, DingTalk, and Enterprise WeChat accounts. Also supports two-factor authentication and open registration.

One-Click Public Access

Supports publicly sharing documents by space, individual document, or document collection. Offers versatile use cases and supports AI question answering based on knowledge base content.

Healthy and Stable Project

We have stable paying customers, an experienced development team, and a consistent release cycle, ensuring reliable updates and a dependable user experience.

Source: zyplayer-doc Official Website

5. Tech Stack

Built on the Shoulders of Giants

This project is built on the following open-source software:

Backend:
Spring-Boot, MyBatis, Druid, MyBatis-Plus, Hutool, Fastjson, Easy Excel, Swagger, Dubbo, JGit, etc.

Frontend:
Vue, vite, element-ui, pinia, wangeditor, mavon-editor, qrcodejs2, vant, vue-router, axios, vue-hljs, brace, echarts, sql-formatter, vue-clipboard2, etc.

Quick Startup

Related Dependencies

Starting this system requires only JAVA and MySQL.

• JAVA 1.8+

• MySQL 5.7.x、8.x

After successfully installing the database, you need to manually create a database named: zyplayer_doc

-- Database Creation Statement
create database zyplayer_doc;

There is no need to manually execute the table creation SQL script. Each time the system starts or is updated, it checks the current version and automatically executes the upgrade SQL scripts. Therefore, whenever a new version is available, simply download and start the latest version without any additional operations.

One-Click Deployment with BaoTa Panel

• Install BaoTa Panel. Visit the official BaoTa Panel website and select the corresponding script for installation. Required BaoTa version: 9.2.0+

• Log in to BaoTa Panel and click Docker in the menu bar. Follow the instructions to install Docker and Docker Compose services. Skip this step if they are already installed.

• Search for zyplayer-doc in Docker - App Store and click Install.

• Configure basic information such as the domain name, then click Confirm.

• After submission, the panel will automatically initialize the application. This usually takes 1–5 minutes. Once initialization is complete, you can access the application.

Start Using the Main Method

1. Modify the database username and password in the application.yml configuration file at zyplayer-doc-manage/src/main/resources/application.yml

2. Run the org.dromara.zyplayer.manage.Application.main method to start the project.

Start Using the JAR Package

1. Direct Download: Download the precompiled JAR package directly. The latest compiled version is available in the Releases section.

2. Build It Yourself: You can also compile the project yourself by double-clicking zyplayer-doc\build.bat. Maven will compile the entire project into an executable JAR file. The compiled files will be placed in the zyplayer-doc\dist\version folder.

3. Modify the database username and password in the application.yml file in the output folder from Step 1 or Step 2.

4. Double-click startup.bat in the output folder from Step 1 or Step 2 to start the project.

Start Using a Tomcat Container

1. Download the precompiled WAR package directly. The latest compiled version is available in the Releases section.

2. Modify the Configuration File: Update the database username and password in zyplayer-doc.zip\apache-tomcat\webapps\zyplayer-doc\WEB-INF\classes\application.yml

3. Double-click tomcat\bin\startup.bat to start the application.

Other Features

For more startup methods, please refer to the documentation: Project Download and Deployment.

After startup, visit: [http://127.0.0.1:8083](http://127.0.0.1:8083). Default login credentials:  Username: zyplayer  Password:  123456