Reference základních pluginů

CatCMS obsahuje několik základních pluginů, které poskytují klíčové funkce pro váš CMS. Tyto pluginy se automaticky instalují a konfigurují při nastavení CatCMS.[object Object]

Přehled

Základní pluginy rozšiřují CatCMS o klíčové funkce, jako je autentizace, správa médií, cachování a administrace databáze. Dodržují stejnou architekturu jako vlastní pluginy, což z nich činí vynikající příklady pro vývoj pluginů.

Dostupné základní pluginy

🔐

Authentication

JWT-based authentication with session management and token refresh

📧

Email

Transactional email sending via Resend with pre-built templates

🔗

Magic Link Auth

Passwordless authentication using secure email magic links

📸

Media

Media file management with R2 storage and image processing

Cache

Three-tier caching system with memory, KV, and database layers

🛠️

Database Tools

Database administration, migrations, and query tools

🌱

Seed Data

Sample data generation for development and testing


Plugin pro autentizaci

Plugin pro autentizaci poskytuje komplexní funkce pro ověřování uživatelů a správu relací.

Funkce

  • Autentizace pomocí JWT tokenů - Bezpečná autentizace založená na tokenech
  • Správa relací - Sledování a správa aktivních uživatelských relací
  • Obnovení tokenu - Automatické obnovení tokenu bez nutnosti opětovné autentizace
  • Omezení počtu požadavků - Ochrana autentizačních koncových bodů před zneužitím
  • Uživatelský kontext - Vkládání dat ověřeného uživatele do kontextu požadavku

Konfigurace

Plugin Configuration

Koncové body API

POST /api/auth/loginOvěří uživatele a získá JWT tokeny

Login Request

POST /api/auth/logoutZneplatní aktuální relaci

GET /api/auth/meZíská informace o aktuálně ověřeném uživateli

POST /api/auth/refreshObnoví vypršený přístupový token

Služby

Auth Service

Hooky

  • auth:login - Spustí se, když se uživatel pokusí přihlásit
  • auth:logout - Spustí se, když se uživatel odhlásí
  • request:start - Vkládá stav autentizace do požadavků

Administrační stránky

  • /admin/auth/sessions - Zobrazení a správa aktivních relací
  • /admin/auth/tokens - Správa API tokenů a přístupových klíčů

Plugin pro e-maily

Plugin pro e-maily poskytuje funkci transakčních e-mailů pomocí služby Resend, s předpřipravenými šablonami pro běžné scénáře autentizace a oznámení.

Funkce

  • Integrace Resend - Odesílání e-mailů přes Resend API
  • E-mailové šablony - Předpřipravené šablony pro registraci, ověření, obnovení hesla a jednorázové kódy
  • Přizpůsobení šablon - Šablony založené na kódu, které lze přizpůsobit
  • Podpora loga - Přidání loga vaší společnosti do e-mailových šablon
  • Správa nastavení - Administrační rozhraní pro konfiguraci nastavení e-mailu
  • Testovací e-mail - Odeslání testovacích e-mailů pro ověření konfigurace

Konfigurace

Plugin Configuration

Nastavení

  1. Zaregistrujte se na Resend a získejte svůj API klíč
  2. Přejděte na /admin/plugins/email/settings ve vaší administraci CatCMS
  3. Nakonfigurujte svůj Resend API klíč a nastavení e-mailu
  4. Odešlete testovací e-mail pro ověření konfigurace

Zahrnuté e-mailové šablony

Potvrzení registraceOdesláno, když si nový uživatel zaregistruje účet

Ověření e-mailuOdesláno pro ověření e-mailových adres uživatelů

Obnovení heslaOdesláno, když uživatelé požádají o obnovení hesla

Jednorázový kód (2FA)Odesláno pro kódy dvoufaktorové autentizace

Použití API

Sending Emails

Administrační stránky

  • /admin/plugins/email/settings - Konfigurace Resend API a nastavení e-mailu

Autentizace magickým odkazem

Plugin pro autentizaci magickým odkazem poskytuje bezheslové ověření prostřednictvím zabezpečených, jednorázových e-mailových odkazů. Uživatelé se mohou přihlásit bez nutnosti pamatovat si hesla.

Funkce

  • Bezheslová autentizace - Nevyžaduje hesla
  • Zabezpečené jednorázové odkazy - Odkazy vyprší po 15 minutách a lze je použít pouze jednou
  • Omezení počtu požadavků - Zabraňuje zneužití pomocí konfigurovatelných limitů počtu požadavků
  • Integrace e-mailu - Spolupracuje s pluginem pro e-maily pro odesílání magických odkazů
  • Automatické vytváření uživatelů - Volitelně vytváří nové uživatele, když požádají o magický odkaz
  • Bezpečnostní sledování - Zaznamenává IP adresy a user agenty pro bezpečnostní audit

Jak to funguje

  1. Uživatel zadá svou e-mailovou adresu
  2. Systém vygeneruje bezpečný, náhodný token
  3. Je odeslán e-mail s magickým odkazem obsahujícím token
  4. Uživatel klikne na odkaz pro ověření
  5. Token je ověřen a označen jako použitý
  6. Uživatel je přihlášen pomocí JWT relace

Konfigurace

Plugin Configuration

Koncové body API

POST /auth/magic-link/requestPožádá o zaslání magického odkazu e-mailem

Request Magic Link

GET /auth/magic-link/verify?token=…Ověří token magického odkazu a přihlásí uživatele

Schéma databáze

Magic Links Table

E-mailová šablona

E-mail s magickým odkazem obsahuje:

  • Výrazné tlačítko “Přihlásit se” s magickým odkazem
  • Upozornění na dobu platnosti
  • Bezpečnostní upozornění, pokud si jej uživatel nevyžádal
  • Moderní, responzivní design

Plugin pro média

Plugin pro média poskytuje komplexní správu mediálních souborů s integrací cloudového úložiště.

Funkce

  • Nahrávání souborů - Nahrávání obrázků, videí a dokumentů do úložiště R2
  • Knihovna médií - Procházení a vyhledávání nahraných mediálních souborů
  • Zpracování obrázků - Změna velikosti, komprese a transformace obrázků
  • Organizace do složek - Uspořádání souborů do složek
  • Extrakce metadat - Automatická extrakce metadat souborů
  • Generování náhledů - Automatické generování náhledů pro obrázky
  • Hromadné operace - Přesun, mazání a zpracování více souborů najednou

Konfigurace

Plugin Configuration

Koncové body API

GET /api/mediaVypíše mediální soubory se stránkováním a filtrováním

List Media

POST /api/media/uploadNahraje nový mediální soubor

Upload File

GET /api/media/:idZíská informace a metadata mediálního souboru

DELETE /api/media/:idSmaže mediální soubor

POST /api/media/processZpracuje média (změna velikosti, komprese, transformace)

POST /api/media/create-folderVytvoří novou složku pro organizaci

POST /api/media/bulk-movePřesune více souborů do složky

Služby

Media Service

Schéma databáze

Media Files Table

Koncové body API

GET /admin/cache/statsZíská podrobné statistiky cache pro všechny jmenné prostory

Cache Stats

POST /admin/cache/clearVymaže všechny položky cache ve všech úrovních

POST /admin/cache/invalidateZneplatní položky cache odpovídající vzoru

Invalidate Cache

GET /admin/cache/browserProcházení a inspekce jednotlivých položek cache

POST /admin/cache/warmPředvyplní cache často přistupovanými daty

Použití v kódu

Using Cache Service

Jmenné prostory cache

content - Obsah a stránky (TTL: 1 hodina) user - Uživatelská data a profily (TTL: 15 minut) api - Data odpovědí API (TTL: 5 minut) media - Metadata mediálních souborů (TTL: 1 hodina) auth - Autentizační tokeny (TTL: 5 minut)

Hooky

  • content:update - Zneplatní cache obsahu
  • content:delete - Zneplatní cache obsahu
  • user:update - Zneplatní cache uživatelů
  • auth:login - Zneplatní cache uživatelů

Nástroje pro databázi

Plugin nástrojů pro databázi poskytuje administrativní nástroje pro správu a vývoj databáze.

Funkce

  • Spouštěč migrací - Spouštění databázových migrací
  • Prohlížeč schématu - Zobrazení tabulek, sloupců a indexů
  • Konzole pro dotazy - Přímé spouštění SQL dotazů
  • Inspektor tabulek - Zobrazení dat a statistik tabulek
  • Zálohování a obnova - Nástroje pro zálohování databáze
  • Metriky výkonu - Analýza výkonu dotazů

Konfigurace

Plugin Configuration

Koncové body API

GET /admin/database/tablesVypíše všechny databázové tabulky

GET /admin/database/tables/:nameZobrazí schéma a data tabulky

POST /admin/database/querySpustí SQL dotaz

Execute Query

POST /admin/database/migrations/runSpustí čekající migrace

GET /admin/database/migrations/statusZkontroluje stav migrací

Služby

Database Service

Administrační stránky

  • /admin/database - Nástěnka databáze
  • /admin/database/tables - Prohlížeč tabulek
  • /admin/database/query - Konzole pro dotazy
  • /admin/database/migrations - Správce migrací

Plugin pro testovací data

Plugin pro testovací data generuje vzorová data pro účely vývoje a testování.

Funkce

  • Vzorový obsah - Generování blogových příspěvků, stránek a článků
  • Testovací uživatelé - Vytváření uživatelských účtů s různými rolemi
  • Mediální soubory - Generování zástupných obrázků a souborů
  • Kolekce - Naplnění vlastních kolekcí daty
  • Vztahy - Vytváření souvisejících dat (uživatelé, příspěvky, komentáře)
  • Přizpůsobitelné - Konfigurace parametrů pro generování dat

Konfigurace

Plugin Configuration

Koncové body API

POST /admin/seed-data/generateVygeneruje testovací data

Generate Seed Data

POST /admin/seed-data/clearSmaže všechna testovací data

GET /admin/seed-data/statusZkontroluje stav testovacích dat

Použití

Seed Data Generation

Administrační stránky

  • /admin/seed-data - Rozhraní pro generování testovacích dat

Další kroky

Was this page helpful?