Как настроить Wiki.js и запустить свою вики за считанные минуты

Wiki.js — это мощная платформа вики с открытым исходным кодом, построенная на Node.js. Она поддерживает как Markdown, так и WYSIWYG редактирование, совместную работу в реальном времени, контроль версий и гибкие варианты аутентификации, включая Google и LDAP. В этом руководстве мы покажем, как настроить Wiki.js с помощью Docker, чтобы вы могли запустить свою вики всего за несколько минут.

Установка Wiki.js с использованием Docker Compose

С помощью Docker и Docker Compose настроить wiki.js невероятно просто. Сначала создайте директорию с именем «wikijs-docker» и перейдите в нее с помощью команды cd:

mkdir wikijs-docker &&cd wikijs-docker

После этого создайте файл «docker-compose.yml» в любом текстовом редакторе:

nano docker-compose.yml

А затем вставьте следующий содержимое в этот файл:

services:  
  
  db:  
    image: postgres:16  
    environment:  
      POSTGRES_DB: wiki  
      POSTGRES_PASSWORD: wikijsrocks  
      POSTGRES_USER: wikijs  
    restart: unless-stopped  
    volumes:  
      - db-data:/var/lib/postgresql/data  
  
  wiki:  
    image: ghcr.io/requarks/wiki:2  
    depends_on:  
      - db  
    environment:  
      DB_TYPE: postgres  
      DB_HOST: db  
      DB_PORT: 5432  
      DB_USER: wikijs  
      DB_PASS: wikijsrocks  
      DB_NAME: wiki  
    restart: unless-stopped  
    ports:  
      - "80:3000"  
  
volumes:  
  db-data:

Сохраните и закройте файл, а затем запустите контейнеры с помощью следующей команды:

docker compose up -d

После завершения настройки откройте wiki.js в вашем браузере по адресу http://localhost. Укажите данные учетной записи администратора и нажмите кнопку Установить, чтобы начать установку:

После установки введите свои учетные данные, чтобы войти.

Создание и управление страницами в Wiki.js

Теперь вы можете создать главную страницу, чтобы начать добавлять контент, или получить доступ к панели администратора для управления настройками, пользователями и функциями:

Если вы нажмете кнопку Создать главную страницу, вам будет предложено выбрать редактор для страницы. Выберите тот, который соответствует вашим предпочтениям и требованиям:

Укажите свойства страницы и нажмите кнопку OK, чтобы создать новую страницу:

Напишите все, что хотите, и нажмите кнопку Создать, чтобы создать страницу:

Управление и организация контента

На панели управления вы можете просматривать и редактировать существующие страницы, создавать новые страницы, используя предпочитаемый редактор, и организовывать свой контент, перемещая, переименовывая или удаляя страницы. Вы также можете добавлять теги для эффективной категоризации контента. Кроме того, боковая панель и строка поиска облегчают быстрое навигацию к конкретным страницам вашей вики:

Настройки сайта Wiki.js

В панели администратора Wiki.js вы можете настроить параметры сайта, такие как локализация, навигация, темы и теги. Эти параметры помогают определить глобальную конфигурацию вашей экземпляра Wiki.js.

Вы можете настроить основные параметры всего сайта на вкладке Общие, такие как название сайта, описание, главная страница по умолчанию и видимость сайта (публичный или приватный):

Перейдите на вкладку Локализация, чтобы установить язык, часовой пояс и форматы даты/времени, используемые на сайте:

Чтобы управлять структурой меню вашей вики и контролировать, как пользователи просматривают контент, перейдите на Навигационную панель.

На вкладке Страницы вы можете просматривать, управлять и организовывать все страницы вики. Вы можете создавать новые страницы, редактировать существующие или управлять иерархией страниц.

Вы также можете создавать и управлять тегами контента на вкладке Теги, чтобы помочь категоризировать страницы и улучшить их поиск. Аналогично, вы можете изменить внешний вид вашей вики на вкладке Темы. Например, вы можете изменить логотип сайта, цвета, шрифты и темы макета.

Управление группами на вашей вики

В разделе Группы вы можете создавать пользовательские группы, назначать участников и устанавливать разрешения на уровне группы для контроля доступа. Используйте группы для организации пользователей по ролям и управления их доступом последовательно по всей вашей вики.

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

Кроме того, вы можете перейти на вкладки Разрешения, Правила страницы и Пользователи, чтобы контролировать, к чему может получить доступ группа и какие пользователи ей назначены.

Управление пользователями в Wiki.js

Чтобы создать нового пользователя, перейдите в раздел Пользователи, нажмите кнопку НОВЫЙ ПОЛЬЗОВАТЕЛЬ и укажите необходимые данные.

После этого нажмите кнопку СОЗДАТЬ или СОЗДАТЬ И ЗАКРЫТЬ, чтобы создать нового пользователя:

Нажмите на конкретного пользователя, чтобы просмотреть и редактировать их профиль, назначить их в группы пользователей, установить методы аутентификации, такие как пароли и двухфакторная аутентификация, и управлять их состоянием с помощью действий, таких как Деактивировать, Подтвердить или Удалить:

Вы также можете обновить их основную информацию, расширенные метаданные (такие как местоположение и должность), и отслеживать их историю активности:

Управление модулями вашей вики

Модули — это дополнительные функции, которые улучшают функциональность Wiki.js. Например, модуль Аналитика позволяет вам включать и настраивать интеграции, такие как Google Analytics, для отслеживания поведения пользователей и трафика на вашей вики.

Используйте вкладку Аутентификация, чтобы настроить и управлять поставщиками аутентификации (такими как локальный вход, LDAP, OAuth) и настроить параметры входа.

Вы можете включить или отключить систему комментариев и выбрать, как пользователи взаимодействуют с обсуждениями страниц.

Системная конфигурация

Вы также можете управлять тем, как контент отображается, ищется и хранится, настраивая движки рендеринга, индексирование поиска и параметры хранения. Например, вы можете перейти на вкладку Рендеринг, чтобы настроить, как контент отображается, такие как настройки движка Markdown или поддержка диаграмм, математических выражений и т. д.

В разделе Поисковая система вы можете настроить параметры внутреннего индексирования поиска и интеграции с поисковыми системами:

Перейдите в раздел Хранение, чтобы установить цели резервного копирования и синхронизации для вашего контента. Здесь вы можете управлять тем, где и как хранятся медиа и вложения страниц (локальная файловая система, AWS S3 и т. д.):

Управление безопасностью и подключением

Вы можете управлять безопасностью и подключением, настраивая доступ к API, настраивая электронную почту для уведомлений, корректируя политики безопасности и включая SSL, чтобы защитить ваш сайт Wiki.js. Например, вы можете управлять API токенами, чтобы интегрировать Wiki.js с внешними системами или вашими собственными приложениями:

Мы можем настроить исходящие параметры электронной почты для обработки уведомлений, приглашений и восстановления пароля в Wiki.js.

Вы можете настроить параметры Безопасности, такие как время ожидания сеанса, политики паролей и ограничения доступа.

Кроме того, вы можете настроить сертификаты SSL/TLS, чтобы защитить ваш сайт Wiki.js с помощью HTTPS.

Кроме того, вы можете подтвердить информацию о вашей вики, например просматривать системные диагностики, детали сервера и статистику среды выполнения в разделе Информация о системе.

Вы можете выполнять действия по обслуживанию, такие как повторное индексирование поиска, очистка кэшей или сброс конфигураций из вкладки Утилиты.

Наконец, Инструменты разработчиков позволяют вам получить доступ к расширенным инструментам, таким как GraphQL playground, логи отладки или пользовательские скрипты:

Теперь, когда вы узнали, как настроить Wiki.js с помощью Docker, вы можете использовать его для создания внутренней документации, командных вики или даже публичных баз знаний с легкостью. Если вы все еще раздумываете над вариантами, ознакомьтесь с нашим сравнением DokuWiki и Wiki.js, чтобы выяснить, какая платформа лучше подходит для вашего проекта.