Перейти к основному содержанию

Переменные окружения сервера

Около 3 мин...

Настроить сервер Waline можно с помощью следующих переменных окружения.

Примечание

После изменения переменных окружения необходимо развернуть проект заново, чтобы изменения вступили в силу.

В Vercel их задают в разделе Settings - Environment Variables.

Основные

Переменная окруженияОбязательноОписание
SITE_NAMEНазвание сайта
SITE_URLURL-адрес сайта
LOGINПри LOGIN=force пользователь должен войти, прежде чем оставить комментарий
SERVER_URLURL-адрес сервера Waline; полезен, если автоматически сгенерированный адрес неверен

Отображение

Переменная окруженияПо умолчаниюОписание
DISABLE_USERAGENTСкрывать ли user agent пользователя, оставившего комментарий. Значение по умолчанию — false
DISABLE_REGIONСкрывать ли регион пользователя, оставившего комментарий. Значение по умолчанию — false
DISABLE_AUTHOR_NOTIFYОтключать ли уведомление автору комментария
AVATAR_PROXY''URL-адрес сервиса проксирования аватаров. Оставьте пустым, чтобы отключить
GRAVATAR_STRhttps://seccdn.libravatar.org/avatar/{{mail|md5}}Строка отрисовки Gravatar на основе шаблона nunjucks
LEVELSВыдавать каждому пользователю метку уровня в зависимости от количества комментариев

Метки уровней

В зависимости от количества комментариев пользователю добавляется метка уровня, определяемая условиями рейтинга. По умолчанию эта возможность отключена; включить её можно, задав переменную окружения LEVELS. Конфигурация представляет собой перечисление заданных чисел через запятую, например 0,10,20,50,100,200 означает:

УровеньУсловияМетки уровней по умолчанию
00 <= count < 10Гномы
110 <= count < 20Хоббиты
220 <= count < 50Энты
350 <= count < 100Маги
4100 <= count < 200Эльфы
5200 <= countМайар

Помимо настройки правил определения уровней, можно настроить и сами метки уровней. Для этого задайте текст в клиенте следующим образом:

Waline.init({
  locale: {
    level0: 'Dwarves',
    level1: 'Hobbits',
    level2: 'Ents',
    level3: 'Wizards',
    level4: 'Elves',
    level5: 'Maiar',
  },
});

По умолчанию предоставляется текст только для 6 уровней, но это не значит, что уровней может быть только 6. Конкретное максимальное число уровней определяется заданными правилами определения уровней. Чтобы добавить новый уровень, рекомендуется самостоятельно задать соответствующий ему текст метки. Если текст метки не задан, по умолчанию отображается текст вида Level 10.

Безопасность

Переменная окруженияПо умолчаниюОписание
IPQPS60Ограничение частоты отправки комментариев с одного IP в секундах. Значение 0 отключает ограничение
SECURE_DOMAINSКонфигурация доверенных доменов. Поддерживает несколько доменов, разделённых запятыми
AKISMET_KEY70542d86693eКлюч антиспам-сервиса Akismet; установите false, чтобы отключить его.
COMMENT_AUDITfalseПереключатель проверки комментариев. Если включён, каждый комментарий должен быть одобрен администратором, поэтому рекомендуется добавить подсказку в placeholder
RECAPTCHA_V3_KEYКлюч reCAPTCHA V3; задаётся вместе с клиентом
RECAPTCHA_V3_SECRETСекрет reCAPTCHA V3 для сервера.
TURNSTILE_KEYКлюч Turnstile; задаётся вместе с клиентом
TURNSTILE_SECRETСекрет Turnstile для сервера

reCAPTCHA и Turnstile

Ключ и секрет Turnstile можно получить по адресу https://www.cloudflare.com/products/turnstile/.

Ключ и секрет reCAPTCHA можно получить по адресу https://www.google.com/recaptcha.

При настройке доверенных доменов нужно одновременно добавить адрес сайта и адрес сервера Waline.

Markdown

Переменная окруженияПо умолчаниюОписание
MARKDOWN_CONFIG{}Конфигурация MarkdownIt
MARKDOWN_HIGHLIGHTtrueВключать ли подсветку кода
MARKDOWN_EMOJItrueВключать ли эмодзи
MARKDOWN_SUBtrueВключать ли нижний индекс
MARKDOWN_SUPtrueВключать ли верхний индекс
MARKDOWN_TEXmathjaxСервис разбора формул; поддерживаются mathjax, katex и false
MARKDOWN_MATHJAX{}Параметры MathJax
MARKDOWN_KATEX{}Параметры KaTeX

Почтовый сервис

Почтовый сервис используется для отправки уведомлений о регистрации пользователей и комментариях. После настройки переменных, связанных с почтовым сервисом, при регистрации пользователя добавляется подтверждение кодом из письма, что защищает от вредоносной регистрации.

Переменная окруженияПримечание
SMTP_SERVICEПровайдер почтового сервиса SMTP
SMTP_HOSTАдрес SMTP-сервера
SMTP_PORTПорт SMTP-сервера
SMTP_USERИмя пользователя SMTP
SMTP_PASSПароль SMTP.
SMTP_SECUREПодключение к SMTP по SSL
SENDER_NAMEНастройка имени отправителя
SENDER_EMAILНастройка адреса электронной почты отправителя

Совет

Список поддерживаемых провайдеров приведён в разделе nodemailer services. Достаточно выбрать что-то одно: SMTP_SERVICE или (SMTP_HOST, SMTP_PORT). Если подходящего SMTP_SERVICE в списке нет, нужно задать SMTP_HOST и SMTP_PORT — их обычно можно найти в настройках почтового ящика.

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

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

База данных

MongoDB

Переменная окруженияОбязательноПо умолчаниюОписание
MONGO_DB✅Имя базы данных MongoDB
MONGO_USER✅Имя пользователя сервера MongoDB
MONGO_PASSWORD✅Пароль сервера MongoDB
MONGO_HOST127.0.0.1Адрес сервера MongoDB, поддерживает формат массива
MONGO_PORT27017Порт сервера MongoDB, поддерживает формат массива
MONGO_REPLICASETНабор реплик MongoDB
MONGO_AUTHSOURCEИсточник аутентификации MongoDB
MONGO_OPT_SSLfalseИспользовать SSL-соединение

MySQL

Переменная окруженияОбязательноПо умолчаниюОписание
MYSQL_DB✅Имя базы данных MySQL
MYSQL_USER✅Имя пользователя сервера MySQL
MYSQL_PASSWORD✅Пароль сервера MySQL
MYSQL_HOST127.0.0.1Адрес сервера MySQL
MYSQL_PORT3306Порт сервера MySQL
MYSQL_PREFIXwl_Префикс таблиц MySQL
MYSQL_CHARSETutf8mb4Кодировка таблиц MySQL
MYSQL_SSLfalseИспользовать ли SSL-соединение

TiDB

Создание базы данных в TiDB

Переменная окруженияОбязательноПо умолчаниюОписание
TIDB_DB✅Имя базы данных TiDB
TIDB_USER✅Имя пользователя сервера TiDB
TIDB_PASSWORD✅Пароль сервера TiDB
TIDB_HOST127.0.0.1Адрес сервера TiDB
TIDB_PORT4000Порт сервера TiDB
TIDB_PREFIXwl_Префикс таблиц TiDB
TIDB_CHARSETutf8mb4Кодировка таблиц TiDB

SQLite

Переменная окруженияОбязательноПо умолчаниюОписание
SQLITE_PATH✅Путь к файлу хранилища SQLite, без имени файла
JWT_TOKEN✅Случайная строка для генератора токенов входа
SQLITE_DBwalineИмя файла хранилища SQLite; измените его, если ваш файл называется не waline
SQLITE_PREFIXwl_Префикс таблиц SQLite

PostgreSQL

Переменная окруженияОбязательноПо умолчаниюОписание
PG_DB✅Имя базы данных PostgreSQL
PG_USER✅Имя пользователя сервера PostgreSQL
PG_PASSWORD✅Пароль сервера PostgreSQL
PG_HOST127.0.0.1Адрес сервера PostgreSQL
PG_PORT5432Порт сервера PostgreSQL
PG_PREFIXwl_Префикс таблиц PostgreSQL
PG_SSLfalseУстановите true, чтобы использовать SSL-соединение
POSTGRES_DATABASEПсевдоним PG_DB
POSTGRES_USERПсевдоним PG_USER
POSTGRES_PASSWORDПсевдоним PG_PASSWORD
POSTGRES_HOST127.0.0.1Псевдоним PG_HOST
POSTGRES_PORT5432Псевдоним PG_PORT
POSTGRES_PREFIXwl_Псевдоним PG_PREFIX
POSTGRES_SSLfalseПсевдоним PG_SSL

GitHub

Переменная окруженияОбязательноПо умолчаниюОписание
GITHUB_TOKEN✅Токены личного доступа
GITHUB_REPO✅Имя репозитория, например walinejs/waline
GITHUB_PATHКаталог хранения данных: например, data означает хранение в каталоге data; по умолчанию корневой каталог

Дополнительно

Переменная окруженияПо умолчаниюОписание
OAUTH_URLhttps://oauth.lithub.ccURL-адрес сервиса входа через соцсети OAuth. Можно развернуть собственный сервис аутентификации.
WEBHOOKМожно задать URL вебхука, который будет вызываться при появлении нового комментария.
WALINE_ADMIN_MODULE_ASSET_URL//unpkg.com/@waline/adminСсылка на панель администратора Waline
IP2REGION_DBПуть к пользовательской библиотеке запросов IPv4 (устарело, используйте IP2REGION_DB_V4)
IP2REGION_DB_V4Путь к пользовательской библиотеке запросов IPv4. Если не задан, используется IP2REGION_DB
IP2REGION_DB_V6Путь к пользовательской библиотеке запросов IPv6. Задайте его, чтобы включить определение местоположения по IPv6
TIPS: Область комментариев предназначена только для демонстрации. Если у вас есть вопросы, пожалуйста, перейдите на Github Discussion чтобы задать их.
GPL-2.0 LICENSE | Copyright © 2020-present lizheming