«Мистер X» или стоит ли небольшой команде рассмотреть XWiki как возможную замену Confluence?
Если я всё правильно понимаю, в феврале 2021 года Atlasian прекратил продажу серверной версии Confluence.
On February 2, 2021 Pacific Time (PT), the following changes will go into effect:
— End of new server license sales: You can no longer purchase or request a quote for a new server product.
— Updates to server prices: We will implement new prices for server renewals and upgrades.
Получается, что отныне для серверной версии нельзя получить новые лицензии, в том числе пробные. И вроде бы ничего страшного, есть бесплатные облачные версии для команд размером до 10 человек. Также можно получить лицензию на версию Data Center. Но что делать, если оба эти варианта не приемлемы?
Требования
Поскольку в моём случае, требования к пространству для документации были не очень высокие, а команда не превышала 25 человек, было принято решение посмотреть в сторону бесплатных альтернатив. После изучения примерно 20 Wiki систем (и не только) наиболее интересной заменой для Confluence мне показалась Xwiki.
В этой статье я кратко рассмотрю способность XWiki заменить для нас базовый функционал Confluence.
На мой взгляд Confluence весьма популярный бренд, претендующий на позицию «стандарта» для портала корпоративной документации. Поэтому возможны случаи, когда люди просто хотят привычный инструмент, не зависимо от реальных потребностей в функционале, это может затруднить переход на другую вики систему.
В нашем случае по факту нужен был весьма скромный набор требований:
бесплатность (или низкая стоимость);
возможность установки на свой сервер;
русификация;
удобное редактирование контента (WYSIWYG или Mardown);
шаблоны страниц;
повторное использования контента;
настройки внешнего вида;
история версий;
аннотации или комментарии к тексту;
управление доступом к страницам для пользователей и групп;
возможность со временем установить расширения если понадобится.
По факту данный набор требований могут удовлетворить разные решения для документирования. Но судя по порталу Xwiki, она позиционируется именно, как opensource альтернатива Confluence. Поэтому выбор пал именно на неё. Кстати почетное второе место в списке заняла BlueSpice MediaWiki, но мне показалось, что там в бесплатной версии количество доступных расширений меньше.
Установка
На текущий момент для загрузки доступны две версии Xwiki:
Stable — включает более новый функционал, но менее стабильна. Цикл обновления примерно раз в месяц.
LTS — по сути прошлогодняя версия, для которой регулярно выпускаются важные исправления и багфиксы.
Для каждой из версий доступны разные способы установки: WAR Package, Docker, или установка из репозитория (Debian / Ubuntu). Xwiki можно установить и в Windows, но я пробовал только установку в Linux Mint. Главное при установке тщательно следовать инструкциям (установка из репозитория / Docker).
При установке с помощью образа Docker рекомендую установить Demo Flavor, чтобы быстро познакомится с наиболее распространенными приемами использования Xwiki, все ненужные расширения, потом можно будет спокойно удалить.
Удовлетворение потребностей
Пробежимся по вышеуказанному списку требований:
Бесплатность и возможность установки на свой сервер
Xwiki — opensource проект. Установка на свой сервер доступна абсолютно бесплатно. Есть коммерческая версия в облаке, но это не для нас. Также есть платные плагины, например улучшенный форум, но острой потребности в них пока нет.
Русификация и редактор
В последних версиях Wiki все критически важные вещи переведены на русский, кое-где не переведены заголовки устанавливаемых приложений, но работа над переводом еще продолжается. Более того при желании Wiki можно сделать мультиязычной.
У Xwiki есть свой стандарт разметки, чем-то напоминающий MediaWiki, при желании можно подключить Markdown, можно писать в чистом HTML, но в принципе TinyMCE в качестве визуального редактора весьма удобен.
Шаблоны страниц, повторное использования контента
Как и в Confluence для страниц можно использовать уже готовые шаблоны или создать свой.
Повторное использование контента в базовой версии можно реализовать через вставку соответствующего макроса. При этом можно вставить как страницу целиком, так и фрагмент между заголовками одного уровня.
Настройки внешнего вида
Можно выбрать тему для сайта, выбранную тему можно разукрасить, к страницам можно применять свои собственные скины, можно добавлять css стили и javascript, управлять меню и панелями. Не весь функционал интуитивно понятен, но главное, что есть возможность.
История версий, аннотации или комментарии к тексту
Для каждой страницы хранится история версий, можно настроить обязательное оставления комментария об изменениях.
Аннотации тоже есть, сделаны на базе расширения функционала комментариев к странице.
Управление доступом и установка расширений
Права доступа можно назначить как отдельному пользователю, так и целой группе. Причем роли можно назначить как сразу для всей вики, так и для отдельных страниц (с вложенными страницами).
Бесплатных расширений много, хотя многие из них бестолковые. Например можно подключить интерпретатор python и писать код внутри страницы. Или подключить DrawIO и чертить схемы прямо на страницах Wiki.
Есть встроенный инструмент для создания собственных мини-приложений на базе Xwiki.
В принципе никто не запрещает самостоятельно разработать расширение, но для этого нужно знать Java.
Больше чем ожидали
Есть еще множество занятного функционала который нам пока не нужен:
интеграция с OpenOffice (LibreOffice);
форум и инструмент для учета идей;
календари, собрания, учет задач;
блоги и голосования;
создание нескольких Wiki (видимо аналог пространств в Confluence)
Думаю со временем, что-то из этого может оказаться востребованным.
Заключение
Xwiki не смотря на некоторую медлительность, за счет своего функционала и его потенциальной расширяемости показалась, мне в долгосрочной перспективе более удобным решением чем GitLab Wiki, DocuWiki, DjangoWiki и другие вики движки, а также другие решения имеющие функционал для документирования (например, Onlyoffice или Youtrack).
Но есть правда в бочке мёда и большая ложка дегтя, помимо вышеупомянутой медлительности (которая в 12-й версии уже не так заметна, как в 11-й), у Xwiki есть еще один недостаток — небольшое сообщество пользователей. На форуме часто отвечают одни и теже люди, а описание некоторых более сложных функций очень сложно найти. Но с базовыми вопросами, как правило больших проблем не возникает.
В целом я пока доволен выбором, да и люди вроде привыкли, так что если вы не притязательны, у вас достаточно воли и терпения, а также есть навыки верстки сайтов, то Xwiki вполне можно рассмотреть как замену Confluence.
Эта публикация получилась достаточно поверхностной, но последняя статья на Хабре по запросу Xwiki была почти 5 лет назад, поэтому я решил что все же стоит «сверить часы» и опубликовать свой взгляд на актуальную версию.
Если история с Xwiki покажется вам интересной, то я напишу еще одну статью, в которой уже более подробно опишу некоторые функции и приемы, которые мне пришлось освоить в процессе первых месяцев её эксплуатации.