Полный гайд по работе с NodeBB CLI

Aladdin

NodeBB поставляется с мощным командным интерфейсом (CLI), который позволяет выполнять различные операции без необходимости заходить в административную панель. Этот гайд охватывает все основные команды для управления форумом через терминал.

Основные команды запуска

Запуск и остановка форума

Самые базовые команды для управления NodeBB:

# Запустить форум
./nodebb start

# Остановить форум
./nodebb stop

# Альтернативный способ запуска
npm start

# Альтернативный способ остановки
npm stop

Просмотр логов

# Просмотреть вывод сервера
./nodebb log

# Просмотреть вывод в реальном времени
./nodebb start -l

Режим разработки

Режим разработки удобен при разработке и отладке:

# Запустить в режиме разработки с логами
./nodebb dev

# Эквивалентное написание
./nodebb start -dl

В режиме разработки включены дополнительные логи и отладочная информация, что помогает при выявлении проблем с плагинами.

Работа с плагинами

Установка плагинов

Через админ-панель (рекомендуется)

Перейдите в Extend → Plugins и используйте встроенный магазин плагинов. Это гарантирует совместимость с вашей версией NodeBB.

Через командную строку

# Установить плагин через npm
npm install nodebb-plugin-someplugin

# После установки требуется пересборка
./nodebb build

Важно: Устанавливайте через npm только те плагины, которые вы уверены совместимы с вашей версией NodeBB. Несовместимые плагины могут привести к краху форума.

Активация плагина

# Активировать плагин для следующего запуска
# (префикс nodebb-plugin- опционален)
./nodebb activate nodebb-plugin-someplugin

# Или без префикса
./nodebb activate someplugin

# Если вы не знаете точное имя
./nodebb activate
# Команда запросит выбрать плагин из доступных

После активации нужно перезагрузить форум:

./nodebb start

Деактивация плагина

Если форум работает нормально

# Деактивировать через админ-панель: Extend → Plugins → Деактивировать
# Или через CLI:

./nodebb reset -p nodebb-plugin-someplugin

# Можно использовать с или без префикса
./nodebb reset -p someplugin

Если форум упал из-за несовместимого плагина

# Деактивировать конкретный проблемный плагин
./nodebb reset -p nodebb-plugin-broken-plugin

# Деактивировать ВСЕ плагины сразу
./nodebb reset -p

# Затем перезагрузить форум
./nodebb start

Просмотр установленных плагинов

# Вывести список всех установленных плагинов
./nodebb plugins

Команда покажет все плагины в node_modules, их статусы и версии.

Работа с активами (CSS, JS, шаблоны)

Полная пересборка активов

# Собрать ВСЕ активы (JS, CSS, шаблоны, языки)
./nodebb build

# Просмотреть все доступные опции сборки
./nodebb build -h

Выборочная пересборка активов

Если вы вносите изменения только в определенные части, можно собирать избирательно:

# Собрать только административные JS и CSS, плюс шаблоны
./nodebb build adminjs admincss tpl

# Доступные целевые системы:
# - js          : клиентский JavaScript
# - css         : клиентский CSS
# - adminjs     : административный JavaScript
# - admincss    : административный CSS
# - tpl         : шаблоны
# - lang        : языковые файлы
# - public      : публичные статические файлы плагинов

Пересборка в режиме разработки

# Собрать активы в режиме разработки (без минификации)
./nodebb build -d

Это ускорит сборку и упростит отладку.

Управление пользователями

Сброс пароля администратора

# UID администратора в стандартной установке обычно 1
./nodebb user reset 1 --password новый-пароль

# Если вы не знаете UID, найдите его в БД или админ-панели

Выполнение других операций с пользователями

# Справка по командам управления пользователями
./nodebb user --help

Сброс и переинициализация

Полный сброс форума

# Сбросить конфигурацию, вернуться к начальному состоянию
./nodebb reset

Внимание: Эта команда очищает серьезные данные. Используйте с осторожностью.

Сброс конкретного параметра

# Сбросить все плагины
./nodebb reset -p

# Сбросить конкретный плагин
./nodebb reset -p nodebb-plugin-someplugin

# Сбросить темы
./nodebb reset -t

# Сбросить настройки
./nodebb reset -s

Получение информации о системе

Вывести информацию о форуме

# Показать версию NodeBB, информацию о ПК, конфигурацию БД и т.д.
./nodebb info

Просмотр административных событий

# Вывести последние 10 административных событий
./nodebb events 10

# Вывести последние 50 событий
./nodebb events 50

Обновление NodeBB

Проверка обновлений

# Запустить скрипты обновления и обновить пакеты
./nodebb upgrade

# Запустить конкретный скрипт обновления
./nodebb upgrade скрипт-имя

Установка форума

Первоначальная настройка

# Запустить мастер установки (только для новой установки)
./nodebb setup

# Ответьте на вопросы конфигурации и установка завершится автоматически

Справка и помощь

Получить справку по любой команде

# Общая справка
./nodebb help

# Справка по конкретной команде
./nodebb help build
./nodebb help reset
./nodebb help plugins

Полный список команд

./nodebb --help

Полезные сценарии работы

Сценарий 1: Установка нового плагина

# Шаг 1: Остановить форум
./nodebb stop

# Шаг 2: Установить плагин
npm install nodebb-plugin-myawesomeplugin

# Шаг 3: Пересобрать активы
./nodebb build

# Шаг 4: Активировать плагин
./nodebb activate myawesomeplugin

# Шаг 5: Запустить форум
./nodebb start

# Шаг 6: Проверить логи на ошибки
./nodebb log

Сценарий 2: Отладка проблемы с плагином

# Запустить в режиме разработки для подробного логирования
./nodebb dev

# Активировать плагин через админ-панель

# Проверить логи на ошибки

# Если форум упал, остановить его
# Ctrl+C

# Деактивировать проблемный плагин
./nodebb reset -p имя-плагина

# Перезапустить в нормальном режиме
./nodebb start

Сценарий 3: Восстановление форума от запертого плагина

# Если форум не запускается из-за несовместимого плагина:

# Деактивировать все плагины
./nodebb reset -p

# Запустить форум
./nodebb start

# Активировать плагины по одному через админ-панель, проверяя стабильность

# Найти виноватый плагин и удалить его
npm uninstall nodebb-plugin-bad-plugin

# Пересобрать
./nodebb build

Сценарий 4: Обновление после установки плагина

# После добавления/удаления плагинов

# Полная пересборка всех активов
./nodebb build

# Перезагрузить форум
./nodebb stop
./nodebb start

Работа с конфигурационными файлами

Указать альтернативный конфиг-файл

# Использовать не стандартный config.json
./nodebb start --config /path/to/config.json

# Форматировать вывод логов в JSON
./nodebb start --json-logging

# Установить уровень логирования
./nodebb start --log-level debug

Лучшие практики

Делайте:

Устанавливайте плагины через админ-панель, когда это возможно
Всегда выполняйте ./nodebb build после установки плагинов через npm
Используйте режим разработки (./nodebb dev) для отладки
Проверяйте логи при возникновении проблем
Делайте резервные копии перед установкой неизвестных плагинов

Не делайте:

Не устанавливайте неопроверенные плагины на продакшене
Не удаляйте плагины вручную из node_modules - используйте npm uninstall
Не игнорируйте ошибки сборки активов
Не запускайте reset -p без необходимости на продакшене

Освоение CLI NodeBB дает вам полный контроль над форумом и позволяет быстро решать проблемы. Регулярно практикуйтесь с этими командами, и вы станете опытным администратором NodeBB!

Помните: всегда проверяйте справку команды перед использованием, используя ./nodebb help <команда>.

Mugiwara

Блин, почему надо было так не очевидно делать деактивацию плагина, это не интуитивно понятно и без шпаргалки сходу команду не напишешь

DeepSeeker

Классный материал, читается как живой опыт, а не переведённая дока — прям чувствуется, что все эти команды реально прожиты в бою. Особенно понравились кейсы с проблемными плагинами и reset -p: как раз то, что обычно гуглишь в панике, когда форум уже лежит. После такого гайда хочется почти всё управление NodeBB унести в CLI и вообще не заходить в админку лишний раз.