Что такое WikiJS
WikiJS — известный вики-движок. Его популярность сегодня растет благодаря таким преимуществам, как открытый исходный код, поддерживаемый большим сообществом разработчиков, простота установки, небольшие системные требования и хорошо читаемая разметка документов по стандарту Markdown.
Требования к серверу
Для установки WikiJS вам необходимы:
- Сервер с не менее чем 1Гб оперативной памяти и как минимум 10Гб дискового пространства;
- Актуальная ОС Linux (в этой статье описан пример на Ubuntu 20.04);
- Учетная запись с повышенными полномочиями;
- Доменное имя с А-записями, "указывающими" на IP сервера (опционально).
Процесс установки
Процесс настройки WikiJS очень прост, достаточно просто выполнить пошаговую инструкцию:
- Авторизуйтесь на сервере, обновите существующее программное обеспечение и перезагрузите компьютер, чтобы изменения вступили в силу;
apt-get update; apt upgrade -y && reboot
- Установите несколько утилит, позволяющих скачивать другие необходимые инструменты и скрипты;
apt install wget curl -y
- Установите nodejs;
curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash - && apt -y install nodejs
ВАЖНО: NodeJS v18 несовместим с WikiJS! Именно поэтому устанавливается более старая версия.
- Добавьте в систему дополнительный репозиторий и установите сервис обслуживания и управления базами данных, например, MariaDB;
apt install -y software-properties-common; curl -LsS https://r.mariadb.com/downloads/mariadb_repo_setup | /bin/bash; apt-get update; apt install -y mariadb-server mariadb-client
- Активируйте, запустите MariaDB, затем проверьте статус службы;
systemctl enable mariadb; service mariadb start
systemctl status mariadb
- Задайте минимум необходимых настроек сервиса БД. Установите желаемый пароль, остальные настройки - на ваше усмотрение, можно и оставить значения по умолчанию;
mysql_secure_installation
- Для более удобного управления службой в будущем, "положите" учетные данные для аутентификации в специальный файл;
nano ~/.my.cnf
[client]
user=root
password=<ваш_пароль>
- Войдите в консоль MariaDB, создайте базу данных и учетную запись и предоставьте этому аккаунту права для управления базой;
create database <имя_базы_данных>;
create user '<логин_пользователя_бд>'@'localhost' identified by '<пароль_пользователя_бд>';
grant all on <имя_базы_данных>.* to '<логин_пользователя_бд>'@'localhost' with grant option;
flush privileges;
exit
- С точки зрения безопасности лучше всего запускать движок WikiJS от имени отдельной учетной записи. Давайте создадим ее и каталог для нашего проекта:
adduser --home /wikijs --disabled-password wikijs
- Авторизуйтесь в системе как только что созданный пользователь, скачайте и распакуйте архив с данными платформы WikiJS;
su wikijs
cd ~; wget https://github.com/Requarks/wiki/releases/latest/download/wiki-js.tar.gz; tar -xf *.tar.gz
- Создайте конфигурационный файл для будущей Вики. Подсказка - можно переименовать предложенный файл шаблона и отредактировать его. Нужно указать тип базы данных и ранее созданные учетные данные к ней;
cp config.sample.yml config.yml; nano config.yml
- Вернитесь обратно в консоль пользователя root, затем создайте через текстовый редактор конфиг для системного сервиса WikiJS:
exit
nano /etc/systemd/system/wiki.service
- Вставьте указанный ниже код в создаваемый файл и сохраните его;
[Unit]
Description=Wiki
After=network.target
[Service]
Type=simple
ExecStart=/usr/bin/node server
Restart=always
User=wikijs
Environment=NODE_ENV=production
WorkingDirectory=/wikijs
[Install]
WantedBy=multi-user.target
- Затем создайте в каталоге WikiJS скрипт start.sh со следующим содержимым:
#/bin/bash
sleep 5
/usr/bin/node /wikijs/server
- "Перечитайте" конфигурацию системы, разрешите автозапуск и запустите созданный вами сервис. Затем проверьте статус службы;
systemctl daemon-reload; systemctl enable wiki; systemctl start wiki
service wiki status
Завершение конфигурирования
Теперь, когда WikiJS работает, можно внести завершающие штрихи и завершить установку. Откройте в браузере адрес http://<IP-адрес_сервера>:3000 (или http://<ваш_домен>:3000), заполните все необходимые данные и нажмите кнопку INSTALL;
Система применит настройки. Когда процесс закончится, вы увидите "приветственный" экран WikiJS. Установка завершилась успешно, поздравляем!
Заключение
После прочтения данной статьи вы знаете, что такое WikiJS, каковы системные требования этой платформы и как установить ее платформу на собственный сервер, управляемый Ubuntu 20.04.