Bot Discord
Companion Discord to opcjonalny dodatek (sprzedawany / pobierany osobno od głównego pakietu NovaDocs). Leży obok instalacji w addons/novadocs-discord.
Łączy się z żywym URL NovaDocs i odpowiada na pytania supportu najlepszym pasującym opublikowanym artykułem. Nie potrzebuje dostępu do bazy — tylko publicznego API wyszukiwania Twojej strony.
Co robi
/docs <zapytanie>— szuka w docs i zwraca najlepszy artykuł (+ powiązane linki)- Auto-odpowiedź na kanale support — gdy ktoś pyta na skonfigurowanym kanale, bot szuka i odpowiada
- @wzmianka —
@Bot jak zainstalować?działa wszędzie na serwerze support - Brak dopasowania — prosi o czekanie na człowieka i nadal linkuje do home docs
Wymagania
- Node.js 20+ (lub Docker)
- Działająca strona NovaDocs (Docker, VPS lub Vercel)
- Aplikacja Discord + bot
1. Utwórz bota Discord
- Otwórz Discord Developer Portal → New Application
- Bot → Add Bot → skopiuj Token
- Włącz Message Content Intent (Bot → Privileged Gateway Intents)
- OAuth2 → URL Generator
- Scopes:
bot,applications.commands - Uprawnienia: Send Messages, Embed Links, Read Message History, Use Slash Commands
- Scopes:
- Zaproś bota na serwer support tym URL
- Skopiuj:
- Client ID aplikacji
- ID serwera (Guild) (tryb dewelopera → PPM na serwer → Copy Server ID)
- Opcjonalnie: ID kanału support (PPM na kanał → Copy Channel ID)
2. Konfiguracja
Z folderu dodatku:
bash
cd addons/novadocs-discord
cp .env.example .env| Zmienna | Wymagana | Opis |
|---|---|---|
DISCORD_TOKEN | tak | Token bota |
DISCORD_CLIENT_ID | tak | Client ID aplikacji |
DISCORD_GUILD_ID | tak | ID serwera support |
DISCORD_SUPPORT_CHANNEL_ID | nie | Jeśli ustawione — auto-odpowiedzi na tym kanale |
NOVADOCS_URL | tak | Dostępny URL NovaDocs (http://127.0.0.1:3000 lokalnie albo żywy https://…) |
NOVADOCS_PROJECT_SLUG | nie | Ogranicz wyszukiwanie do jednego projektu (np. guide) |
AUTO_REPLY | nie | true / false (domyślnie true) |
MAX_RESULTS | nie | 1–5 wyników (domyślnie 3) |
COOLDOWN_SECONDS | nie | Cooldown na użytkownika na kanale (domyślnie 20) |
3. Uruchomienie
npm install
npm startKomendy slash rejestrują się przy starcie. Samo rejestrowanie:
bash
npm run registerWażne
Upewnij się, że NEXT_PUBLIC_APP_URL na stronie NovaDocs zgadza się z publicznym URL w NOVADOCS_URL, żeby linki do artykułów działały.
tip
Trzymaj bota tylko na #support / #help (DISCORD_SUPPORT_CHANNEL_ID), żeby nie pisał wszędzie. Używaj /docs, gdy chcesz jawnego wyszukiwania.
Powiązane
- Konfiguracja webhooków — embedy przy publikacji (to coś innego niż ten bot)
- Pełny README w pakiecie dodatku:
addons/novadocs-discord/README.md
