Wiki.js - это бесплатное современное вики-приложение с открытым исходным кодом, созданное на Node.js , Git и Markdown . Исходный код Wiki.js публично размещен на Github . Это руководство покажет вам, как установить Wiki.js на свежий экземпляр Ubuntu 18.04 LTS Vultr, используя Node.js, MongoDB, PM2, Nginx, Git и Acme.sh.
Требования
Требования для запуска Wiki.js и завершения этого руководства следующие:
- Node.js версии 6.9.0 или новее
- MongoDB версии 3.2 или выше
- Nginx
- Git версии 2.7.4 или новее
- Минимум 768 МБ ОЗУ
- Доменное имя с
A
/ AAAA
записи настроены
Проверьте версию Ubuntu.
lsb_release -ds
# Ubuntu 18.04.4 LTS
Создайте новую non-root
учетную запись пользователя с sudo
доступом и переключитесь на нее.
adduser johndoe --gecos "John Doe"
usermod -aG sudo johndoe
su - johndoe
ПРИМЕЧАНИЕ . Замените johndoe
на свое имя пользователя.
Установите часовой пояс.
sudo dpkg-reconfigure tzdata
Убедитесь, что ваша система обновлена.
sudo apt update && sudo apt upgrade -y
Установите необходимые пакеты.
sudo apt install -y build-essential apt-transport-https
Установить Git
Git 2.7.4 поставляется с предустановленной версией Ubuntu Server, поэтому нам не нужно его устанавливать. Если вы хотите установить более новую версию, вы можете использовать сторонние PPA или скомпилировать последнюю версию Git из исходного кода.
Вы можете проверить установленную версию Git, запустив:
git --version
# git version 2.7.4
Если вы хотите установить более новую версию программного обеспечения Git, вы можете использовать следующее.
# Remove existing git package
sudo apt remove -y git
sudo apt-get install software-properties-common
sudo add-apt-repository -y ppa:git-core/ppa
sudo apt update && sudo apt upgrade -y
sudo apt install -y git
Проверьте версию Git.
git --version
# git version 2.17.0
Установите Node.js
Установите Node.js, используя репозиторий NodeSource APT для Node.js.
curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt install -y nodejs
Проверьте версии Node.js и NPM.
node -v && npm -v
# v8.11.2
# 5.6.0
Установить MongoDB
Мы будем использовать официальные репозитории MongoDB , которые обновляются до самых последних основных и второстепенных выпусков MongoDB.
Установите MongoDB Community Edition.
sudo apt install -y mongodb
Проверьте версию.
mongo --version | head -n 1 && mongod --version | head -n 1
# MongoDB shell version v3.6.3
# db version v3.6.3
Установите Nginx.
wget https://nginx.org/keys/nginx_signing.key
sudo apt-key add nginx_signing.key
rm nginx_signing.key
sudo -s
printf "deb https://nginx.org/packages/mainline/ubuntu/ $(lsb_release -sc) nginx\ndeb-src https://nginx.org/packages/mainline/ubuntu/ $(lsb_release -sc) nginx\n" >> /etc/apt/sources.list.d/nginx_mainline.list
exit
sudo apt update
sudo apt install -y nginx
Проверьте версию.
sudo nginx -v
# nginx version: nginx/1.15.0
Включите и запустите Nginx.
sudo systemctl enable nginx.service
sudo systemctl start nginx.service
Настройте Nginx в качестве обратного прокси-сервера для приложения Wiki.js.
Запустите sudo vim /etc/nginx/conf.d/wiki.js.conf
и заполните его базовой конфигурацией обратного прокси ниже.
server {
listen [::]:80;
listen 80;
server_name wiki.example.com;
root /usr/share/nginx/html;
charset utf-8;
client_max_body_size 50M;
location /.well-known/acme-challenge/ {
allow all;
}
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
по умолчанию.
Проверьте конфигурацию.
sudo nginx -t
Перезагрузить Nginx.
sudo systemctl reload nginx.service
Установите клиент Acme.sh и получите сертификат Let's Encrypt (необязательно)
Защищать вашу вики с помощью HTTPS
не обязательно, но это защитит трафик вашего сайта. Acme.sh - это чистая оболочка Unix для получения сертификатов SSL от Let's Encrypt с нулевыми зависимостями.
Скачать и установить 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 ~
Проверьте версию.
/etc/letsencrypt/acme.sh --version
Получите сертификаты RSA и ECDSA для wiki.example.com
домена / имени хоста.
# RSA 2048
sudo /etc/letsencrypt/acme.sh --issue --home /etc/letsencrypt -d wiki.example.com --webroot /usr/share/nginx/html --reloadcmd "sudo systemctl reload nginx.service" --accountemail [email protected] --ocsp-must-staple --keylength 2048
# ECDSA/ECC P-256
sudo /etc/letsencrypt/acme.sh --issue --home /etc/letsencrypt -d wiki.example.com --webroot /usr/share/nginx/html --reloadcmd "sudo systemctl reload nginx.service" --accountemail [email protected] --ocsp-must-staple --keylength ec-256
После выполнения вышеуказанных команд ваши сертификаты и ключи будут в:
- Для RSA:
/etc/letsencrypt/wiki.example.com
каталог.
- Для ECC / ECDSA:
/etc/letsencrypt/wiki.example.com_ecc
каталог.
После получения сертификатов от Let's Encrypt нам необходимо настроить Nginx для их использования.
Запустите sudo vim /etc/nginx/conf.d/wiki.js.conf
снова и настройте Nginx в качестве HTTPS
обратного прокси.
server {
listen [::]:443 ssl http2;
listen 443 ssl http2;
listen [::]:80;
listen 80;
server_name wiki.example.com;
root /usr/share/nginx/html;
charset utf-8;
client_max_body_size 50M;
location /.well-known/acme-challenge/ {
allow all;
}
# 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;
}
}
Проверьте конфигурацию.
sudo nginx -t
Перезагрузить Nginx.
sudo systemctl reload nginx.service
Установить Wiki.js
Создайте пустую корневую папку с документом, где должен быть установлен Wiki.js.
sudo mkdir -p /var/www/wiki.example.com
Перейдите в корневую папку документа.
cd /var/www/wiki.example.com
Смена владельца /var/www/wiki.example.com
папки на пользователя johndoe
.
sudo chown -R johndoe:johndoe /var/www/wiki.example.com
Из /var/www/wiki.example.com
папки выполните следующую команду, чтобы загрузить и установить Wiki.js.
curl -sSo- https://wiki.js.org/install.sh | bash
Чтобы просмотреть текущую версию Wiki.js, вы можете запустить следующую команду.
node wiki --version
# 1.0.78
После завершения установки вам будет предложено запустить мастер настройки.
Запустите мастер настройки.
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 поставляется вместе с Wiki.js в качестве локального модуля NPM, поэтому нам не нужно устанавливать PM2 глобально.
Скажите PM2 настроить себя в качестве службы запуска.
/var/www/wiki.example.com/node_modules/pm2/bin/pm2 startup
Наконец, сохраните текущую конфигурацию PM2.
/var/www/wiki.example.com/node_modules/pm2/bin/pm2 save
Wiki.js работает как фоновый процесс, используя PM2 в качестве менеджера процессов.