Markdown Doc Service

Требования к среде:

• версия Node.js 4.0+;
• Git используется для обновления содержимого MD-документа.
• Nginx (необязательно) используется в качестве обратного прокси для портов 80 и 43. Необязательно, но рекомендуется, так как это упрощает Google-индексирование с использованием HTTPS и домена.

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

1. Извлечение исходного кода из Git

git clone https://gitee.com/geliang/MarkDownNodeWebServer.git

2. Настройка номера порта

По умолчанию номер порта — 3000. При необходимости можно открыть файл multiple-instances.js в каталоге example, найти его в конце и изменить номер порта.

vim ./example/multiple-instances.js

Найдите следующий код и измените номер порта на нужный вам.

const server = mainApp.listen(3000, function () {
  debug('Express HTTP server listening on port ' + server.address().port);
});

Измените права доступа к файлу multiple-instances.js, чтобы сделать его исполняемым.

chmod +x multiple-instances.js

3. Настройка автоматического обновления контента блога

Если в вашем блоге есть изменения в содержании, они будут автоматически обновлены после отправки в Git-сервер. Сайт обновляется мгновенно благодаря использованию Git Webhook для запуска скрипта обновления. Это безопасный и эффективный способ достичь цели «реального времени» обновления блога.

3.1 Настройка скрипта для операции обновления

Этот скрипт будет вызываться через интерфейс ./webhook. Откройте файл ./example/scripts/pulldoc.sh и настройте адрес вашего документа в Git.

vim ./example/scripts/pulldoc.sh

Файл должен содержать примерно следующее содержимое:

#!/bin/bash
pwd
cd example
if [ ! -d "content" ];then
    git clone git:xxxxxxxxxxxxxx content
fi
cd content

git pull

Замените адрес Git на адрес вашего документа Git.

Примечание: Если ваш Git-репозиторий защищён паролем или требует проверки SSH, необходимо настроить проверку Git. Примечание: После адреса Git обязательно добавьте поле content, которое указывает на каталог, где хранится исходный документ.

3.2 Настройка WebHook

В настройках GitHub/Gitee установите адрес WebHook на yourhost.com/webhook. Пример показан на скриншоте ниже.

Запуск сервиса

Установите зависимости проекта Node в корневом каталоге исходного кода.

npm install

Для отладки и разработки вы можете запустить сервер напрямую, запустив server.js. Чтобы запустить сервис с помощью pm2, сначала установите инструмент pm2 глобально.

## Установите pm2
npm install pm2 -g
## Запустите сервис
pm2 start --name=MarkDownDocServer npm -- start

Проверьте, успешно ли запущен сервис, просмотрев журналы pm2.

pm2 logs MarkDownDocServer
# Или используйте pm2 list для просмотра списка сервисов.

Откройте браузер и введите адрес и номер порта, чтобы проверить, успешно ли он запущен.

http://host:port

Другие операции с сервисом

Используйте pm2 для просмотра, удаления и перезапуска сервисов.

Просмотр имени сервиса и ID:

pm2 list

Удаление сервиса:

pm2 delete [id или имя сервиса]

Перезапуск сервиса:

pm2 retart [id или имя сервиса]