zyplayer-doc

Специализированная платформа для управления частной онлайн-библиотекой знаний.

Подходит для использования в качестве корпоративной или личной базы данных, заметок и инструментов управления документами. Документы могут быть опубликованы в виде общедоступных ресурсов, таких как корпоративные документы или справочные материалы.

Опыт работы: http://zyplayer.com. Онлайн-документы: http://doc.zyplayer.com.

Приглашаем к сотрудничеству всех заинтересованных! Если вам нравится проект, поставьте ему звезду, чтобы поддержать его развитие!

Присоединяйтесь к нашему сообществу в WeChat и общайтесь с нами!

Чтобы присоединиться к группе, добавьте нас в друзья в WeChat, отправьте сообщение «Присоединиться» — мы добавим вас в группу.

Быстрый старт

Зависимости

Для запуска системы требуются только JAVA и MySQL.

• JAVA 1.8+
• MySQL 5.7.x, 8.x

После установки базы данных необходимо вручную создать базу данных zyplayer_doc.

-- Создание базы данных
create database zyplayer_doc;

Скрипты создания таблиц не нужно запускать вручную после каждого обновления. Они будут автоматически выполняться при каждом обновлении, поэтому достаточно просто загрузить последнюю версию и запустить её без дополнительных действий.

Запуск через панель управления PaaS

• Установите панель управления PaaS, перейдите на официальный сайт PaaS, выберите нужный скрипт и загрузите его. Версия PaaS: 9.2.0+
• Войдите в панель управления PaaS и установите Docker и Docker Compose. Если они уже установлены, пропустите этот шаг.
• В магазине Docker найдите zyplayer-doc, нажмите «Установить».
• Настройте домен и другие параметры, затем нажмите «Подтвердить».
• После отправки панель управления PaaS автоматически инициализирует приложение. Это может занять от 1 до 5 минут. После завершения инициализации вы сможете получить доступ к приложению.

Метод main для запуска

1. Измените файл конфигурации application.yml в папке zyplayer-doc-manage/src/main/resources.
2. Запустите проект с помощью метода com.zyplayer.doc.manage.Application.main.

Запуск с использованием JAR-файла

1. Скачайте готовый JAR-файл, скомпилированный с помощью Maven. Вы можете найти последнюю версию на странице загрузки.
2. Соберите проект самостоятельно, запустив zyplayer-doc\build.bat. Maven скомпилирует весь проект в исполняемый JAR-файл. Результат будет находиться в папке dist\version.
3. Измените пароль базы данных в файле application.yml, который находится в папке zyplayer-doc\dist\version.
4. Запустите проект, используя startup.bat из папки zyplayer-doc\dist\version.

Запуск в контейнере Tomcat

1. Загрузите готовый WAR-файл, скомпилированный с помощью Maven. Вы также можете найти его на странице загрузки.
2. Измените пароль базы данных в файле конфигурации zyplayer-doc.zip\apache-tomcat\webapps\zyplayer-doc\WEB-INF\classes\application.yml.
3. Запустите Tomcat, используя tomcat\bin\startup.bat.

Другие способы

Дополнительные инструкции по запуску можно найти в документации: скачать и развернуть.

После запуска перейдите по адресу http://127.0.0.1:8083. По умолчанию логин — zyplayer, пароль — 123456.

Описание модулей

zyplayer-doc-manage — управление документами

Этот модуль предоставляет следующие функции:

• навигация по проектам и группам пользователей;
• управление пользователями и группами;
• организация пространства для хранения документов;
• предоставление доступа к документам на основе групп пользователей.

Это координирующий модуль для всех остальных модулей.

zyplayer-doc-wiki — вики-инструмент для работы с документами

С помощью этого инструмента можно управлять документами в режиме онлайн. Он позволяет:

• создавать документы, организованные по пространству и группам пользователей, с возможностью предоставления общего доступа;
• редактировать документы с использованием HTML или Markdown;
• комментировать документы;
• загружать файлы в документы;
• просматривать историю изменений документов;
• контролировать доступ к документам;
• осуществлять поиск документов.

В этом инструменте используются такие технологии, как Vue, Element-UI, Mavon-Editor и Wangeditor.

Он был разработан на основе Atlassian Confluence и представляет собой бесплатную альтернативу этому продукту. Также он может использоваться в качестве внутреннего инструмента для управления корпоративными документами.

zyplayer-doc-db — инструмент для работы с базами данных

Инструмент для управления базами данных. Позволяет:

• управлять базами данных MySQL, Doris (MySQL-совместимыми), SQLServer, Oracle, DB2, PostgreSQL, Hive, Impala;
• просматривать таблицы и поля баз данных;
• экспортировать таблицы и документацию;
• выполнять SQL-запросы;
• предварительно просматривать данные таблиц;
• переносить данные между различными базами данных;
• предоставлять доступ к базам данных на основе пользователей и таблиц.

Цель этого инструмента — заменить Navicat и предоставить компактный и бесплатный онлайн-инструмент для управления базами данных.

zyplayer-doc-api — инструмент для документирования API

Поддерживает Swagger, OpenApi и пользовательские API. Предоставляет следующие возможности:

• просмотр документации Swagger;
• тестирование API;
• быстрое выполнение запросов;
• удобный интерфейс.

Целью этого инструмента является создание платформы для централизованного управления документацией API для различных проектов.

Прочее

• zyplayer-doc-ui — исходный код интерфейса для всех модулей;
• zyplayer-doc-core — общие классы;
• zyplayer-doc-data — взаимодействие с базой данных;
• zyplayer-doc-other — тестовые файлы.

Пожертвования

Если вы используете этот проект и считаете его полезным, вы можете поддержать его следующими способами:

1. Поставьте звёздочку проекту zyplayer-doc.
2. Сохраните ссылку на страницу «О проекте».
3. Используйте коммерческую версию doc.zyplayer.com. Онлайн-страница отладки.