Как установить Wiki.js на FreeBSD 11

• Требования
• Прежде чем вы начнете
• Установите Node.js
• Установить MongoDB
• Установите Acme.sh и получите сертификат Let's Encrypt (необязательно)
• Установите и настройте Nginx
• Установить Wiki.js
• Установите и настройте менеджер процессов PM2

Wiki.js - это бесплатное современное вики-приложение с открытым исходным кодом, созданное на Node.js, MongoDB, Git и Markdown. Исходный код Wiki.js публично размещен на Github . Это руководство покажет вам, как установить Wiki.js на свежий экземпляр FreeBSD 11 Vultr с помощью Node.js, MongoDB, PM2, Nginx, Git и Acme.sh.

Требования

Требования для запуска Wiki.js следующие:

• Node.js версии 6.11.1 или новее
• MongoDB версии 3.2 или выше
• Git версии 2.7.4 или новее
• Веб-сервер, такой как Nginx, Apache, IIS, Caddy или H2O. Это руководство будет использовать Nginx.
• Git-совместимое хранилище (публичное или частное) Это необязательно
• Минимум 512 МБ ОЗУ. Настоятельно рекомендуется использовать компьютер с объемом оперативной памяти не менее 1 ГБ.
• Доменное имя с A/ AAAAзаписи настроены. В этом руководстве мы будем использовать wiki.example.comв качестве примера домена.

Прежде чем вы начнете

Проверьте версию FreeBSD.

uname -ro
# FreeBSD 11.2-RELEASE

Убедитесь, что ваша система FreeBSD обновлена.

freebsd-update fetch install
pkg update && pkg upgrade -y

Установить sudo, vim, unzip, wget, git, bashи socatпакеты , если они не присутствуют в вашей системе.

pkg install -y sudo vim unzip wget git bash socat

Создайте новую учетную запись пользователя с вашим предпочтительным именем пользователя (мы будем использовать johndoe).

adduser

# Username: johndoe
# Full name: John Doe
# Uid (Leave empty for default): <Enter>
# Login group [johndoe]: <Enter>
# Login group is johndoe. Invite johndoe into other groups? []: wheel
# Login class [default]: <Enter>
# Shell (sh csh tcsh nologin) [sh]: bash
# Home directory [/home/johndoe]: <Enter>
# Home directory permissions (Leave empty for default): <Enter>
# Use password-based authentication? [yes]: <Enter>
# Use an empty password? (yes/no) [no]: <Enter>
# Use a random password? (yes/no) [no]: <Enter>
# Enter password: your_secure_password
# Enter password again: your_secure_password
# Lock out the account after creation? [no]: <Enter>
# OK? (yes/no): yes
# Add another user? (yes/no): no
# Goodbye!

Запустите visudoкоманду и раскомментируйте %wheel ALL=(ALL) ALLстроку, чтобы члены wheelгруппы могли выполнить любую команду.

# Uncomment by removing the hash (#) sign
%wheel ALL=(ALL) ALL

Теперь переключитесь на нового пользователя.

su - johndoe

ПРИМЕЧАНИЕ. Замените johndoeна свое имя пользователя.

Установите часовой пояс.

sudo tzsetup

Установите Node.js

Wiki.js требует Node.js 6.11.1 или новее, поэтому сначала нам нужно установить соответствующую версию Node.js.

Установите Node.js и NPM.

sudo pkg install -y node8 npm-node8

Проверьте версии.

node -v && npm -v
# v8.12.0
# 6.4.1

Установить MongoDB

Wiki.js использует MongoDB в качестве движка базы данных.

Установите MongoDB.

sudo pkg install -y mongodb36

Проверьте версию.

mongo --version | head -n 1 && mongod --version | head -n 1
# MongoDB shell version v3.6.6
# db version v3.6.6

Включите и запустите MongoDB.

sudo sysrc mongod_enable=yes
sudo service mongod start

Установите Acme.sh и получите сертификат Let's Encrypt ( необязательно )

Защита вашей вики с помощью HTTPS не обязательна, но это хорошая практика для защиты трафика вашего сайта. Для получения SSL-сертификата от Let's Encrypt мы будем использовать клиент Acme.sh. Acme.sh - это чистая оболочка Unix для получения SSL-сертификатов от Let's Encrypt с нулевыми зависимостями. Это делает его очень легким по сравнению с некоторыми другими клиентами протокола Acme, которым для успешной работы требуется много зависимостей.

Загрузите и установите Acme.sh.

sudo mkdir /etc/letsencrypt
git clone https://github.com/Neilpang/acme.sh.git
cd acme.sh
sudo ./acme.sh --install --home /etc/letsencrypt --accountemail [email protected]
cd ~

Проверьте acme.shверсию.

/etc/letsencrypt/acme.sh --version
# v2.8.0

Получить сертификаты RSA и ECDSA для wiki.example.com.

# RSA 2048
sudo /etc/letsencrypt/acme.sh --issue --standalone --home /etc/letsencrypt -d wiki.example.com --ocsp-must-staple --keylength 2048
# ECDSA/ECC P-256
sudo /etc/letsencrypt/acme.sh --issue --standalone --home /etc/letsencrypt -d wiki.example.com --ocsp-must-staple --keylength ec-256

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

• RSA: /etc/letsencrypt/wiki.example.com
• ECC / ECDSA: /etc/letsencrypt/wiki.example.com_ecc

ПРИМЕЧАНИЕ: не забудьте заменить wiki.example.comна ваше доменное имя.

После получения сертификатов от Let's Encrypt нам нужно настроить Nginx для их использования.

Установите и настройте Nginx

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

Установите Nginx.

sudo pkg install -y nginx

Проверьте версию.

nginx -v
# nginx version: nginx/1.14.0

Включите и запустите Nginx.

sudo sysrc nginx_enable=yes
sudo service nginx start

Настройте Nginx как обратный прокси-сервер HTTPS (если вы используете SSL) для приложения Wiki.js.

Запустите sudo vim /usr/local/etc/nginx/wiki.js.confи заполните его базовой конфигурацией обратного прокси ниже.

server {

  listen [::]:443 ssl http2;
  listen 443 ssl http2;
  listen [::]:80;
  listen 80;

  server_name wiki.example.com;

  charset utf-8;
  client_max_body_size 50M;

  # RSA
  ssl_certificate /etc/letsencrypt/wiki.example.com/fullchain.cer;
  ssl_certificate_key /etc/letsencrypt/wiki.example.com/wiki.example.com.key;
  # ECDSA
  ssl_certificate /etc/letsencrypt/wiki.example.com_ecc/fullchain.cer;
  ssl_certificate_key /etc/letsencrypt/wiki.example.com_ecc/wiki.example.com.key;

  location / {
    proxy_set_header Host $http_host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_pass http://127.0.0.1:3000;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    proxy_next_upstream error timeout http_502 http_503 http_504;
  }

}

Единственное, что вам нужно изменить в приведенной выше конфигурации, это server_nameдиректива и, возможно, proxy_passдиректива, если вы решите настроить какой-либо другой порт, кроме 3000. Wiki.js использует порт 3000по умолчанию. Сохраните файл и выйдите с помощью :+ W+Q

Теперь нам нужно включить wiki.js.confфайл в основной nginx.confфайл.

Запустите sudo vim /usr/local/etc/nginx/nginx.confи добавьте следующую строку в http {}блок.

include wiki.js.conf;

Проверьте конфигурацию.

sudo nginx -t

Перезагрузить Nginx.

sudo service nginx reload

Установить Wiki.js

Создайте пустую корневую папку документа, в которую будет установлен Wiki.js.

sudo mkdir -p /usr/local/www/wiki.example.com

Перейдите в корневую папку документа.

cd /usr/local/www/wiki.example.com

Смена владельца /usr/local/www/wiki.example.comпапки на пользователя johndoe.

sudo chown -R johndoe:johndoe /usr/local/www/wiki.example.com

Из /usr/local/www/wiki.example.comпапки выполните следующие команды, чтобы загрузить и установить Wiki.js.

curl -sSo- https://wiki.js.org/install.sh | bash

VERSION=$(curl -L -s -S https://beta.requarks.io/api/version/stable)
curl -L -s -S https://github.com/Requarks/wiki/releases/download/v$VERSION/wiki-js.tar.gz | tar -f - -xz -C .
curl -L -s -S https://github.com/Requarks/wiki/releases/download/v$VERSION/node_modules.tar.gz | tar -f - -xz -C .
cp -n config.sample.yml config.yml

Вы можете выполнить следующую команду, чтобы просмотреть текущую установленную версию Wiki.js.

node wiki --version
# 1.0.102

После завершения установки вам будет предложено запустить мастер настройки.

Запустите мастер настройки, запустив.

node wiki configure

Это уведомит вас, чтобы перейти http://localhost:3000к настройке Wiki.js. Если у вас есть Nginx перед Wiki.js, это означает, что вы можете открыть свое доменное имя (например http://wiki.example.com) вместо перехода на localhost.

С помощью веб-браузера перейдите к http://wiki.example.comинструкциям на экране и следуйте им. Все настройки, введенные в мастере конфигурации, сохраняются в config.ymlфайле. Мастер настройки автоматически запустит Wiki.js для вас.

Установите и настройте менеджер процессов PM2

По умолчанию Wiki.js не запускается автоматически после перезагрузки системы. Чтобы запустить его при загрузке, нам нужно установить и настроить менеджер процессов PM2.

Установите PM2 глобально через npm.

sudo npm install -g pm2

Проверьте версию.

pm2 -v
# 3.2.2

Перейдите в корневую папку вашего документа, если вы еще не там, и остановите Wiki.js.

cd /usr/local/www/wiki.example.com
node wiki stop

Запустите Wiki.js через PM2.

pm2 start server/index.js --name "Wiki.js"

Список процессов, управляемых PM2.

pm2 list

Скажите PM2, чтобы он сконфигурировал себя как службу запуска, запустив:

pm2 startup

Наконец, сохраните текущую конфигурацию PM2, выполнив команду:

pm2 save

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