Як встановити Wiki.js на FreeBSD 11

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

NOTE: Don't forget to replace wiki.example.com with your domain name.

After obtaining certificates from Let's Encrypt, we need to configure Nginx to take advantage of them.

Install and configure Nginx

Wiki.js can run without any actual web server, however it is highly recommended to put a standard web server in front of it. This ensures you can use features like SSL, multiple websites, caching and others. We will use Nginx in this tutorial, but any other server will do, you just need to configure it properly.

Install Nginx.

sudo pkg install -y nginx

Check the version.

nginx -v
# nginx version: nginx/1.14.0

Enable and start Nginx.

sudo sysrc nginx_enable=yes
sudo service nginx start

Configure Nginx as a HTTPS (if you use SSL) reverse proxy for the Wiki.js application.

Run sudo vim /usr/local/etc/nginx/wiki.js.conf and populate it with the basic reverse proxy configuration below.

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 як менеджер процесів.