Dokumentacja RIVET SECURITY
Wszystko, czego potrzebujesz, aby zainstalować, skonfigurować i obsługiwać RIVET SECURITY. Wybierz język na dole panelu bocznego.
$curl -fsSL https://get.rivet-security.com | sh
Pierwsze kroki
Instalacja
Zainstaluj RIVET SECURITY jednym poleceniem — pobiera obraz Dockera i uruchamia agenta.
curl -fsSL https://get.rivet-security.com | sh
Wymagania: host z systemem Linux, Docker 24.0+ oraz Docker Compose.
docker --version # 24.0+ required
docker compose version
Pierwsza konfiguracja
Ustaw ścieżki logów i kanały powiadomień w pliku środowiskowym, a następnie uruchom kontenery.
nano /opt/rivet/.env
docker compose up -d
Sprawdź działanie
Wywołaj punkt końcowy health — powinieneś otrzymać odpowiedź OK z wersją.
curl localhost:8080/api/v1/health
# {"status":"ok","version":"1.0.0"}
Panel
Panel to Twoja konsola operacyjna w czasie rzeczywistym. Każda sekcja aktualizuje się na żywo.
Status — czas działania, CPU, pamięć, dysk, połączenia i dzisiejsze blokady.
Alerty — zdarzenia bezpieczeństwa według wagi, z adresem IP i podjętym działaniem.
Zablokowane IP — zarządzaj zbiorem nftables; przedłużaj, odblokowuj lub dodawaj IP ręcznie.
Logi SSH — strumień logów na żywo dla SSH, Nginx i Apache z filtrami.
Ustawienia — informacje o serwerze, licencja, funkcje i kanały alertów.
Kanały powiadomień
RIVET SECURITY może powiadamiać przez Telegram, Slack, Discord i e-mail. Ustaw odpowiednie zmienne w .env.
Telegram
RIVET_TELEGRAM_TOKEN=123456:ABC-DEF
RIVET_TELEGRAM_CHAT=8842019
Slack / Discord
RIVET_SLACK_WEBHOOK=https://hooks.slack.com/services/...
RIVET_DISCORD_WEBHOOK=https://discord.com/api/webhooks/...
Email
RIVET_SMTP_HOST=smtp.example.com
RIVET_ALERT_EMAIL=lukas@rivet-security.com
Funkcje PRO
Te funkcje są zawarte w planie PRO (€99).
WAF — zestaw reguł OWASP blokuje SQLi, XSS, RCE, SSRF i path traversal.
Wynik bezpieczeństwa — audyt hardeningu CIS z gotowymi poprawkami.
Threat Intel — wyselekcjonowane źródła reputacji i botnetów, automatycznie odświeżane.
Źródła ataków — globalna mapa cieplna na żywo wg liczby ataków.
Etykiety strumienia logów
Na stronie Logs chipy filtrów dzielą się na dwie grupy — źródło logu i poziom ważności.
Źródła
SSH — logowanie i sesje powłoki (port 22).
NGINX — logi dostępu i błędów Nginx.
APACHE — logi serwera Apache.
SYS — zdarzenia systemowe i silnika Rivet.
Poziomy
INFO — zwykłe komunikaty operacyjne.
OK — poprawne zdarzenia i testy.
WARN — podejrzana aktywność wymagająca uwagi.
BLOCK — Rivet zablokował IP lub odrzucił ruch.
Dokumentacja API
Każda akcja jest dostępna przez REST API z uwierzytelnianiem tokenem. Przekaż klucz jako token Bearer.
curl -H "Authorization: Bearer $RIVET_API_KEY" \
https://node-7a:8080/api/v1/status
Punkty końcowe
GET /api/v1/status
GET /api/v1/blocks
POST /api/v1/blocks { "ip": "1.2.3.4", "ttl": 86400 }
DELETE /api/v1/blocks/:ip
POST /api/v1/score/scan
Rozwiązywanie problemów
Zacznij od podglądu logów kontenera.
docker compose logs -f rivet
Kontener nie startuje — sprawdź, czy Docker działa i port 8080 jest wolny.
Brak logów — sprawdź, czy SSH_LOG_PATH i NGINX_LOG_PATH wskazują na istniejące pliki.
Alerty nie docierają — sprawdź adresy webhooków i uruchom rivet test-alert.
Nadal problem? Napisz na lukas@rivet-security.com, dołączając logi kontenera.