Термины, определённые один раз

Программное обеспечение, которое работает на оборудовании, принадлежащем оператору или арендованном им напрямую, без чего-либо на стороне разработчика.

Self-hosted продукт вы устанавливаете на собственную машину, и он работает там. Никакая база разработчика не хранит ваши записи, нет учётных записей на пользователя, и никакой сервис не может отозвать доступ к данным, которые уже лежат на вашем диске. Так работают оба продукта Vorqul: VorqulBOT как процесс Node, а VorqulPanel как Java JAR.

VorqulPanelDirect answers

Связанные Панель управления серверомТелеметрияРазовая лицензия

Единый административный интерфейс для служб, работающих на Linux-сервере.

Панель управления собирает веб-хостинг, DNS, почту, базы данных, доступ к файлам, правила firewall и мониторинг в одном интерфейсе. Обычные изменения больше не означают отдельный конфигурационный файл для каждой подсистемы. VorqulPanel охватывает эти области на одном сервере, а собственные данные хранит в SQLite или, по желанию, в MySQL, MariaDB или PostgreSQL.

VorqulPanel

Связанные Self-hostedПереключатель модуляБаза данных панели

Одна покупка, покрывающая одно развёртывание, вместо регулярной подписки.

VorqulPanel лицензируется так. Вы платите один раз за развёртывание, цена зависит от числа серверов, на которых он работает, а купленной версией можно пользоваться дальше без продления. Распространение, перепродажа, сублицензирование и хостинг для третьих лиц исключены.

License

Связанные Self-hostedТелеметрия

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

Телеметрия встречается и в открытом, и в коммерческом ПО, а разработчики обычно называют её анонимной. Продукты Vorqul не отправляют никакой. Это значит и отсутствие проверки лицензии во время работы, и ничего, что перестало бы работать, если бы перестал работать разработчик.

Direct answers

Связанные Self-hostedЖурнал аудита

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

Знать, что настройка изменилась, это одно. Знать, кто её изменил, когда и откуда, это то, что даёт журнал аудита. VorqulBOT ведёт его для каждого сервера, а VorqulPanel для каждой машины, и оба остаются на инфраструктуре, которую контролирует оператор.

Moderation

Связанные Двухфакторная аутентификация (TOTP)История дел

Где VorqulPanel хранит собственное состояние: по умолчанию SQLite, с MySQL, MariaDB и PostgreSQL как вариантами и SQL Server в бете.

Она отделена от баз данных, которые панель создаёт для ваших сайтов. Смена движка позже не переносит данные, поэтому выберите его при установке через DB_ENGINE.

Database managementUnattended install

Связанные Панель управления серверомOffsite-копия

Настройка, которая включает или выключает целую часть VorqulPanel: игровой хостинг, веб-хостинг, почту или одну из их подфункций.

Выключенный переключатель скрывает пункт меню и заставляет API отвечать 404, поэтому до функции не добраться даже по URL. Ничего не удаляется и никакие данные не стираются, а при повторном включении всё возвращается.

Feature switches

Связанные Root helper (vorqul-helper)vorqulctl

Второй шаг входа с временным кодом из приложения, который VorqulPanel может требовать от администраторов.

Включите её в Settings, Account сразу после создания администратора. Если вы потеряете доступ, vorqulctl reset-admin выдаст новую ссылку для настройки.

First login

Связанные Setup URLЖурнал аудита

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

Он оборачивает службу systemd и задачи вокруг неё: status, logs, setup-url, reset-admin, modules, update с автоматическим откатом, fix-libs и uninstall. Запускается от root или через sudo.

Command reference

Связанные Setup URLRoot helper (vorqul-helper)Переключатель модуля

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

Он принимает фиксированный список действий и отклоняет всё остальное. Его политика лежит в /etc/vorqul-helper.conf и урезана до включённых вами модулей, поэтому одно включение модуля в Settings не даёт панели этих прав.

The root helper

Связанные vorqulctlЛимиты cgroup v2Переключатель модуля

Одноразовая ссылка, которую выводит установщик и которая открывает форму создания первой учётной записи администратора.

Пока администратора нет, создать его может тот, кто первым достучится до порта панели, поэтому окно закрывается через час после запуска панели. vorqulctl setup-url выводит новую ссылку, а vorqulctl reset-admin выдаёт ссылку для нового администратора.

First login

Связанные vorqulctlДвухфакторная аутентификация (TOTP)

Шаг безопасности, который VorqulPanel выполняет перед применением изменения веб-сервера: проверяет новую конфигурацию и, если проверка не прошла, возвращает старую.

Поэтому плохой vhost не роняет весь сервер. Та же идея работает для DNS-зон, которые перед перезагрузкой BIND проверяются через named-checkzone.

Web hostingDNS

Связанные Виртуальный хост (vhost)Перехват vhostDNS-зона

Блок конфигурации веб-сервера, который говорит nginx или Apache, какой сайт отдавать для данного доменного имени.

VorqulPanel записывает только собственные файлы vhost с префиксом vorqul- и не трогает всё остальное в конфигурации веб-сервера.

Web hosting

Связанные Перехват vhostПроверка конфигурации с откатомРежим reverse proxy

Явное подтверждение, которое нужно, прежде чем VorqulPanel сможет управлять сайтом, найденным уже настроенным на сервере.

Принятые сайты читаются без переписывания. После подтверждения сначала делается копия, а перехват только убирает ссылку в sites-enabled и никогда не удаляет исходный файл.

Installing on a used server

Связанные Виртуальный хост (vhost)Проверка конфигурации с откатом

Настройка домена, которая ставит vhost веб-сервера перед приложением, работающим на локальном порту.

Панель пишет vhost и может выпустить сертификат, поэтому любое приложение, в том числе служба на Node.js или Python, работает на обычном домене с HTTPS.

Web hosting

Связанные Виртуальный хост (vhost)ACME и Let's Encrypt

Механизм ядра Linux, которым VorqulPanel ограничивает память, CPU и число процессов каждого игрового сервера.

Он заменяет nice, cpulimit и ulimit, которые либо не ограничивают реальное использование, либо замораживают процесс. Сервер, превысивший потолок, убивается в собственной группе, а панель записывает, что это сделало ядро, так что вы отличите убийство из-за нехватки памяти от сбоя.

Game hosting

Связанные Разбор паденийRoot helper (vorqul-helper)

Функция VorqulPanel, которая читает последние строки упавшего игрового сервера и называет вероятную причину и решение.

Типичные причины: не та версия Java, занятый порт, нехватка памяти, отсутствующее EULA, сломанный плагин или полный диск. Автоматический перезапуск пропускается, когда перезапуск не поможет.

Game hosting

Связанные Лимиты cgroup v2

Резервная копия, отправленная в хранилище вне сервера, чтобы потеря машины не означала потерю копий.

VorqulPanel шифрует копию через AES-256-GCM до того, как она покинет сервер. Цели настраиваются в панели, а до облака вроде Google Drive можно добраться через rclone.

Backups guide

Связанные Restore drillБаза данных панели

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

Она доказывает, что архив действительно можно восстановить, а это не то же самое, что архив существует.

Backups guide

Связанные Offsite-копия

Учётная запись для передачи файлов, ограниченная одним каталогом, поэтому она не может просматривать остальную часть сервера.

Каждый игровой сервер в VorqulPanel получает собственную SFTP-учётку в chroot, а сайты могут иметь её, ограниченную своей папкой. Защита от подбора паролей встроена.

SFTP

Связанные Журнал аудитаnftables

Пакетный фильтр Linux, которым VorqulPanel управляет рядом с ufw и firewalld для открытия и закрытия портов.

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

Firewall

Связанные SFTP в chrootRoot helper (vorqul-helper)

Набор DNS-записей домена, который VorqulPanel может обслуживать сама через BIND9.

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

DNS

Связанные Проверка конфигурации с откатомDKIMPTR-запись

Протокол и бесплатный удостоверяющий центр, которые VorqulPanel через acme.sh или certbot использует для выпуска сертификатов HTTPS.

Для выпуска DNS-запись сначала должна указывать на сервер, либо нужен токен Cloudflare DNS, которым имя подтверждается без порта 80. Let's Encrypt допускает только пять неудачных проверок на hostname в час, поэтому перед обращением к центру панель проверяет DNS, порт 80 и покрытие vhost.

Web hosting

Связанные Режим reverse proxyDNS-зона

Криптографическая подпись исходящей почты, публикуемая как DNS-запись, по которой получатели проверяют, что письмо пришло с вашего домена.

В VorqulPanel ключ создаётся через Rspamd при добавлении почтового домена, и панель показывает запись для публикации. Она лежит под доменом из заголовка From, никогда под именем почтового хоста.

Mail

Связанные SPF и DMARCPTR-записьДоставляемость

Две DNS-записи, которые говорят, какие серверы могут отправлять почту от имени домена и что получателям делать с почтой, не прошедшей проверку.

Они работают вместе с DKIM. VorqulPanel создаёт записи, а его проверка доставляемости сообщает, когда одной нет или она неверна.

Mail

Связанные DKIMДоставляемостьMTA-STS и TLS-RPT

Обратная DNS-запись, сопоставляющая IP-адрес сервера с именем хоста, которую проверяют принимающие почтовые серверы.

Она задаётся там, где арендуется IP, поэтому ни одна панель не изменит её за вас. Имя почтового хоста, не совпадающее с PTR, вредит доставляемости сильнее, чем отсутствие сертификата.

Mail

Связанные DKIMДоставляемость

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

Без MTA-STS тот, кто может перехватить соединение, способен убрать предложение STARTTLS, и отправитель тихо перейдёт на передачу без шифрования. Сам файл политики должен отдаваться по адресу https://mta-sts.ваш-домен/.well-known/mta-sts.txt.

Mail

Связанные SPF и DMARCДоставляемость

Доходит ли отправленная вами почта до ящика, а не отклоняется или попадает в спам.

Она зависит от PTR, SPF, DKIM, DMARC и репутации IP-адреса. VorqulPanel проверяет записи, почтовую очередь и основные публичные блок-листы и говорит, что именно является проблемой.

Mail

Связанные DKIMSPF и DMARCPTR-записьMTA-STS и TLS-RPT

Сводная оценка, которую VorqulBOT считает по сигналам активности, удержания участников, роста и адаптации новичков на сервере Discord.

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

Server Health ScoreLeveling

Пронумерованный журнал каждого модераторского действия на сервере Discord, по которому можно искать.

Каждый бан, кик, предупреждение или тайм-аут создаёт дело с целью, модератором, причиной, длительностью и временем. Спустя месяцы всё ещё можно сказать, почему было принято решение и кто его принял, и именно ради этого дела хранятся.

ModerationAutoMod

Связанные Журнал аудитаЛестница эскалацииТранскрипт тикета

Единый список из 44 модулей, который читают и VorqulBOT, и его дашборд, поэтому переключатель не может существовать в одном и игнорироваться в другом.

Реестр называет каждый модуль, его группу и то, включён ли он по умолчанию. Девять включены с самого начала: модерация, уровни, afk, опросы, экономика, игры, розыгрыши, напоминания и команды с префиксом. Остальные 35 выключены. Процесс бота и веб-дашборд читают один и тот же файл, поэтому две половины не могут разойтись, а это типичная беда ботов с отдельным веб-интерфейсом.

PluginsVorqulBOT

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

Фильтры охватывают спам, повторяющийся текст, ссылки, приглашения, капс, упоминания, массовые упоминания, ghost-пинги, потоки эмодзи, потоки спойлеров, zalgo, фишинг, поддельный nitro, криптомошенничество и собственные регулярные выражения. По умолчанию включены только фишинг и поддельный nitro. Каждый фильтр работает независимо, поэтому один может удалять, другой давать тайм-аут, а третий банить.

AutoMod

Связанные Лестница эскалацииShadow-mute

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

У VorqulBOT их два. Эскалация AutoMod срабатывает при повторных срабатываниях фильтра в окне, по умолчанию в один час. Действия при предупреждениях работают так же, но вручную: число, окно в днях и действие, так что три предупреждения за семь дней могут означать мут. Несколько правил можно сочетать, а рецидивисты эскалируются сами.

ModerationAutoMod

Связанные История делФильтр AutoModJail

Мут, при котором участник по-прежнему видит свои сообщения, а все остальные нет.

Он убирает обратную связь. Скажите участнику, что он замучен, и он начнёт спорить или вернётся с другого аккаунта. Дайте ему видеть свои сообщения опубликованными как обычно, и он, как правило, теряет интерес. VorqulBOT предлагает его как shadowmute и unshadowmute рядом с обычным mute, тайм-аутом и jail.

Moderation

Модераторское состояние, которое отбирает у участника роли и сужает доступ до ограниченного набора каналов.

Jail находится между тайм-аутом и баном. Участник остаётся на сервере, и с ним ещё можно говорить, что помогает, пока вы разбираетесь с инцидентом, но он теряет доступ ко всему, к чему имел доступ раньше. Роли возвращаются при unjail.

Moderation

Связанные Проверка альтернативных аккаунтовЛестница эскалации

Модуль, который позволяет старым текстовым командам вроде !daily работать рядом со slash-командами.

Slash-команды выигрывают почти по всем статьям, но сервер, который три года пишет !daily, будет писать и дальше. Мост сопоставляет текстовую форму с тем же обработчиком. Никому не нужно переучиваться, и ничего не поддерживается дважды. Это один из девяти модулей, включённых по умолчанию.

VorqulBOTEconomy

Связанные Slash-команда

Файл конфигурации, который говорит панели Pterodactyl, как установить и запустить конкретное приложение.

VorqulBOT поставляется с ним. Импортируйте его, загрузите файлы по SFTP, впишите токен Discord в переменные Startup и нажмите старт. Первый запуск сам установит зависимости и скомпилирует код. Если вы уже используете панель для игрового хостинга, это самый короткий путь запустить бота.

VorqulBOTDirect answers

Связанные Self-hostedPrivileged intents

Лимит на уровне сервера в VorqulBOT (free, premium или pro), который повышает потолки нескольких функций.

Потолки касаются закреплённых сообщений, ролей по реакции, автоответов, запланированных сообщений и исходящих вебхуков. Free допускает 3 закреплённых сообщения, 5 ролей по реакции, 10 автоответов, 5 запланированных сообщений и ни одного вебхука. Pro допускает 100, 100, 500, 200 и 5. Бот self-hosted, поэтому уровень вы выставляете своим серверам сами и никогда не покупаете его у меня.

Direct answers

Хеш HMAC-SHA256 тела запроса, отправляемый в заголовке, чтобы получатель мог доказать, что запрос пришёл от бота.

VorqulBOT отправляет на выбранный вами адрес четыре события об участниках: вход, выход, бан и разбан. Если задать общий секрет, каждый запрос несёт заголовок X-Vorqul-Signature, вычисленный по телу этим секретом, и ваш endpoint может отклонить всё, что не совпадает. Без секрета события всё равно приходят, просто без проверки подлинности.

Plugins

Связанные Вход в дашборд через OAuth2

Минимальное время между двумя сообщениями, которые обе приносят XP. VorqulBOT по умолчанию использует 60 секунд.

Без cooldown уровни вознаграждают объём, и верх таблицы лидеров достаётся тому, кто напишет больше всего однословных сообщений. С ним двадцать быстрых сообщений приносят ровно столько же, сколько одно. Это самая важная настройка системы уровней, а серверы чаще всего оставляют её такой, с какой пришёл бот.

Leveling

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

Аккаунт младше 7 дней получает 40, младше 30 дней 25, младше 90 дней 10. Аватар по умолчанию добавляет 20, вход менее суток назад 15, отсутствие ролей 10, а боты получают ноль. Относитесь к результату как к основанию для решения человека и пропустите автоматический бан. Такие эвристики дают ложные срабатывания, а неверный бан стоит больше доверия, чем экономит времени.

ModerationAnti-Raid

Связанные JailИстория дел

Переписка в тикете поддержки, записанная в текстовый файл и отправленная в назначенный вами канал.

VorqulBOT экспортирует последние 100 сообщений канала тикета. Столько Discord возвращает одним запросом, и обычно этого хватает на весь тикет. Файл намеренно простой: текст, авторы и время, поэтому он открывается где угодно и по нему легко искать. Ничего не уходит во внешний сервис.

Tickets

Настройки Discord, которые бот должен включить, чтобы видеть присутствие, участников сервера и содержимое сообщений.

VorqulBOT нужны включённые интенты присутствия, участников сервера и содержимого сообщений в портале разработчиков Discord. Без них кажется, что команды ничего не делают.

Discord setup

Связанные Slash-командаВход в дашборд через OAuth2

Команда Discord, вводимая с косой чертой в начале, которую бот регистрирует в Discord, и тот показывает её в списке команд.

Регистрация требует scope applications.commands в приглашении и шага deploy. Когда slash-команд нет, повторите deploy и проверьте scope приглашения.

VorqulBOT

Связанные Privileged intentsPrefix bridge

Как вы входите в дашборд VorqulBOT: через Discord, с адресом перенаправления, который должен совпадать с зарегистрированным.

Несовпадение redirect URI в портале Discord и адреса дашборда самая частая причина неудачного входа. Если оставить NEXTAUTH_URL пустым, адрес определится автоматически.

First dashboard sign-in

Связанные Privileged intentsПодпись вебхука

Текстовый индекс в корне сайта, который указывает языковым моделям на его каноническое содержимое.

Соглашение берёт форму у robots.txt и работает наоборот: вместо ограничения роботов оно даёт им отобранную карту. Это формирующееся соглашение, а не утверждённый стандарт, и никто независимо не показал, насколько оно помогает поиску. vorqul.com публикует его по адресу /llms.txt, а полную версию по адресу /llms-full.txt.

llms.txt

Связанные Entity homeСерверный рендеринг

Единственная каноническая страница, которой владеет бренд и которая в машиночитаемом виде говорит, что он такое.

Entity home делает явные утверждения о категории, назначении и аудитории, подкрепляет их структурированными данными и подтверждается, когда то же описание появляется в профилях третьих сторон. Если эти источники расходятся, система доверяет сущности меньше. Для Vorqul это страница /about, связанная с идентификатором в Wikidata.

About

Связанные llms.txt

Создание полного HTML до того, как он попадёт к клиенту, вместо сборки страницы JavaScript в браузере.

Поисковые роботы за движками ответов загружают HTML и обычно пропускают JavaScript, поэтому всё, что появляется только после гидрации на клиенте, для них невидимо. vorqul.com собран статически. Каждая страница приходит как полный HTML, а немного JavaScript отвечает за меню, подсказку языка и аналитику, на которую вы согласились.

Связанные llms.txt