Search documentation of phoenix_kit

# API Reference phoenix_kit v#1.7.87

Copy Markdown View Source

## Modules

PhoenixKit

PhoenixKit

PhoenixKit.AWS.CredentialsVerifier

AWS credentials verification module.

PhoenixKit.AWS.InfrastructureSetup

Automated AWS infrastructure setup for email event handling.

PhoenixKit.AWS.SESv2

AWS SES v2 API client for operations not supported by ExAws.

PhoenixKit.Admin.Events

PubSub event broadcasting for PhoenixKit admin panels.

PhoenixKit.Admin.Presence

Phoenix.Presence implementation for tracking anonymous and authenticated sessions.

PhoenixKit.Admin.SimplePresence

Simple presence tracking system for PhoenixKit admin interface.

PhoenixKit.Application

OTP Application module for PhoenixKit.

PhoenixKit.AuditLog

Context for managing audit logs in PhoenixKit.

PhoenixKit.AuditLog.Entry

Schema for audit log entries.

PhoenixKit.Cache

Generic caching system for PhoenixKit with ETS-backed storage.

PhoenixKit.Cache.Registry

Lightweight Registry wrapper for PhoenixKit.Cache instances.

PhoenixKit.Config

Configuration management system for PhoenixKit.

PhoenixKit.Config.AWS

AWS configuration management for PhoenixKit.

PhoenixKit.Config.AdminDashboardCategories

Admin dashboard categories configuration and validation for PhoenixKit.

PhoenixKit.Config.EndpointUrlSync

Syncs the `site_url` from PhoenixKit settings to the parent Phoenix Endpoint's `:url` configuration.

PhoenixKit.Config.UeberAuth

Ueberauth configuration management for PhoenixKit.

PhoenixKit.Config.UserDashboardCategories

User dashboard categories configuration and validation for PhoenixKit.

PhoenixKit.Dashboard

User Dashboard Tab Management System.

PhoenixKit.Dashboard.AdminTabs

Default admin navigation tabs for PhoenixKit.

PhoenixKit.Dashboard.Badge

Defines badge types for dashboard tab indicators.

PhoenixKit.Dashboard.ContextSelector

Configuration and helpers for the dashboard context selector.

PhoenixKit.Dashboard.Group

Struct representing a dashboard tab group.

PhoenixKit.Dashboard.Presence

Presence tracking for dashboard tabs.

PhoenixKit.Dashboard.Registry

Registry for managing dashboard tabs across the application.

PhoenixKit.Dashboard.Tab

Defines the Tab struct and related types for the user dashboard navigation system.

PhoenixKit.Dashboard.TabHelpers

Shared helper functions for dashboard sidebar navigation.

PhoenixKit.Email.DefaultProvider

No-op email provider. Used when phoenix_kit_emails package is not installed.

PhoenixKit.Email.Provider

Unified email provider behaviour.

PhoenixKit.Install.ApplicationSupervisor

Installation helper for adding PhoenixKit supervisor to parent application. Used by `mix phoenix_kit.install` task.

PhoenixKit.Install.AssetRebuild

Handles asset rebuilding for PhoenixKit installations and updates.

PhoenixKit.Install.BasicConfiguration

Installation helper for adding PhoenixKit supervisor to parent application. Used by `mix phoenix_kit.install` task.

PhoenixKit.Install.BrowserPipelineIntegration

Handles automatic integration of PhoenixKit plugs into the browser pipeline.

PhoenixKit.Install.Common

Common utilities shared between PhoenixKit installation and update tasks.

PhoenixKit.Install.CssIntegration

Handles automatic Tailwind CSS + DaisyUI integration for PhoenixKit installation.

PhoenixKit.Install.DbConnectionCheck

Simple database connection check for PhoenixKit installation.

PhoenixKit.Install.DemoFiles

Handles copying demo test files for PhoenixKit installation.

PhoenixKit.Install.EndpointIntegration

Endpoint integration for PhoenixKit installation.

PhoenixKit.Install.FinchSetup

Handles automatic Finch and HTTP client setup for PhoenixKit installation.

PhoenixKit.Install.IgniterConfig

Helper functions for working with Igniter to read and modify parent project configuration.

PhoenixKit.Install.IgniterHelpers

Helper functions for working with Igniter to detect parent application information.

PhoenixKit.Install.LayoutConfig

Handles layout integration configuration for PhoenixKit installation.

PhoenixKit.Install.MailerConfig

Handles mailer configuration for PhoenixKit installation.

PhoenixKit.Install.MigrationStrategy

Handles migration strategy determination and execution for PhoenixKit installation.

PhoenixKit.Install.OAuthConfig

Handles OAuth configuration for PhoenixKit installation.

PhoenixKit.Install.ObanConfig

Handles Oban configuration for PhoenixKit installation.

PhoenixKit.Install.RateLimiterConfig

Handles Hammer rate limiter configuration for PhoenixKit installation.

PhoenixKit.Install.RepoDetection

Handles repository detection and validation for PhoenixKit installation.

PhoenixKit.Install.RouterIntegration

Handles router integration for PhoenixKit installation.

PhoenixKit.Install.RuntimeDetector

Detects Phoenix runtime configuration patterns and determines appropriate config strategy.

PhoenixKit.Jobs

Jobs module for PhoenixKit.

PhoenixKit.LayoutConfig

Configuration manager for PhoenixKit layout integration.

PhoenixKit.Mailer

Mailer module for PhoenixKit emails.

PhoenixKit.Migration

Migrations create and modify the database tables PhoenixKit needs to function.

PhoenixKit.Migrations.Postgres

PhoenixKit PostgreSQL Migration System

PhoenixKit.Migrations.Postgres.V02

PhoenixKit Migration V02: Remove is_active column from role assignments.

PhoenixKit.Migrations.Postgres.V03

PhoenixKit V03 Migration: Settings System

PhoenixKit.Migrations.Postgres.V04

PhoenixKit V04 Migration: Settings Module Column + Referral System

PhoenixKit.Migrations.Postgres.V05

PhoenixKit V05 Migration: Add Beneficiary Field to Referral Codes

PhoenixKit.Migrations.Postgres.V06

PhoenixKit V06 Migration: Allow NULL Expiration Dates for Referral Codes

PhoenixKit.Migrations.Postgres.V07

PhoenixKit V07 Migration: Email System

PhoenixKit.Migrations.Postgres.V08

PhoenixKit V08 Migration: Username Support

PhoenixKit.Migrations.Postgres.V09

PhoenixKit V09 Migration: Email Blocklist Support

PhoenixKit.Migrations.Postgres.V10

PhoenixKit V10 Migration: User Registration Analytics

PhoenixKit.Migrations.Postgres.V11

PhoenixKit V11 Migration: Per-User Timezone Settings

PhoenixKit.Migrations.Postgres.V12

PhoenixKit V12 Migration: JSON Settings Support

PhoenixKit.Migrations.Postgres.V13

PhoenixKit V13 Migration: Enhanced Email Tracking with AWS SES Integration

PhoenixKit.Migrations.Postgres.V14

PhoenixKit V14 Migration: Email Body Compression Support

PhoenixKit.Migrations.Postgres.V15

PhoenixKit V15 Migration: Email Templates System

PhoenixKit.Migrations.Postgres.V16

PhoenixKit V16 Migration: OAuth Providers System & Magic Link Registration

PhoenixKit.Migrations.Postgres.V17

PhoenixKit V17 Migration: Entities System (Dynamic Content Types)

PhoenixKit.Migrations.Postgres.V18

PhoenixKit V18 Migration: User Custom Fields

PhoenixKit.Migrations.Postgres.V19

PhoenixKit V19 Migration: Enhanced Email Status Tracking

PhoenixKit.Migrations.Postgres.V20

PhoenixKit V20 Migration: Distributed File Storage System

PhoenixKit.Migrations.Postgres.V21

PhoenixKit V21 Migration: Optimize Message ID Search Performance

PhoenixKit.Migrations.Postgres.V22

PhoenixKit V22 Migration: Email System Improvements & Audit Logging

PhoenixKit.Migrations.Postgres.V23

PhoenixKit V23 Migration: Session Fingerprinting

PhoenixKit.Migrations.Postgres.V24

PhoenixKit V24 Migration: File Checksum Unique Index

PhoenixKit.Migrations.Postgres.V25

PhoenixKit V25 Migration: Aspect Ratio Control for Dimensions

PhoenixKit.Migrations.Postgres.V26

Migration V26: Rename checksum fields and add per-user deduplication.

PhoenixKit.Migrations.Postgres.V27

Migration V27: Add Oban tables for background job processing.

PhoenixKit.Migrations.Postgres.V28

Migration V28: Add preferred_locale field to users table for dialect preferences.

PhoenixKit.Migrations.Postgres.V29

PhoenixKit V29 Migration: Posts System

PhoenixKit.Migrations.Postgres.V30

Migration V30: Move preferred_locale from column to custom_fields JSONB.

PhoenixKit.Migrations.Postgres.V31

PhoenixKit V31 Migration: Billing System - Phase 1

PhoenixKit.Migrations.Postgres.V32

PhoenixKit V32 Migration: AI System

PhoenixKit.Migrations.Postgres.V33

PhoenixKit V33 Migration: Payment Providers and Subscriptions

PhoenixKit.Migrations.Postgres.V34

PhoenixKit V34 Migration: AI Endpoints System

PhoenixKit.Migrations.Postgres.V35

PhoenixKit V35 Migration: Support Tickets System

PhoenixKit.Migrations.Postgres.V36

PhoenixKit V36 Migration: Connections Module - Social Relationships System

PhoenixKit.Migrations.Postgres.V37

PhoenixKit V37 Migration: DB Sync - Connections & Transfer Tracking

PhoenixKit.Migrations.Postgres.V38

PhoenixKit V38 Migration: AI Prompts System

PhoenixKit.Migrations.Postgres.V39

PhoenixKit V39 Migration: Admin Notes System

PhoenixKit.Migrations.Postgres.V40

PhoenixKit V40 Migration: UUID Column Addition for Legacy Tables

PhoenixKit.Migrations.Postgres.V41

PhoenixKit V41 Migration: AI Request Prompt Tracking & Reasoning Parameters

PhoenixKit.Migrations.Postgres.V42

PhoenixKit V42 Migration: Universal Scheduled Jobs System

PhoenixKit.Migrations.Postgres.V43

PhoenixKit V43 Migration: Legal Module

PhoenixKit.Migrations.Postgres.V44

PhoenixKit V44 Migration: Rename DB Sync tables to Sync

PhoenixKit.Migrations.Postgres.V45

PhoenixKit V45 Migration: E-commerce Shop Module

PhoenixKit.Migrations.Postgres.V46

V46: Product Options with Dynamic Pricing + Import Logs + Translations

PhoenixKit.Migrations.Postgres.V47

V47: Shop Localized Fields

PhoenixKit.Migrations.Postgres.V48

V48: Post and Comment Dislikes

PhoenixKit.Migrations.Postgres.V49

V49: Shop Import Enhancements

PhoenixKit.Migrations.Postgres.V50

V50: Add access_type to storage buckets

PhoenixKit.Migrations.Postgres.V51

V51: Cart items unique constraint fix + User deletion FK constraints

PhoenixKit.Migrations.Postgres.V52

V52: Shop localized slug functional unique index

PhoenixKit.Migrations.Postgres.V53

V53: Module-Level Permission System

PhoenixKit.Migrations.Postgres.V54

V54: Category Featured Product + Import Config download_images

PhoenixKit.Migrations.Postgres.V55

V55: Standalone Comments Module

PhoenixKit.Migrations.Postgres.V56

V56: UUID Column Consistency Fix

PhoenixKit.Migrations.Postgres.V57

V57: UUID FK Column Repair

PhoenixKit.Migrations.Postgres.V58

V58: Timestamp Column Type Standardization (timestamptz)

PhoenixKit.Migrations.Postgres.V59

V59: Publishing Module — Database Tables

PhoenixKit.Migrations.Postgres.V60

V60: Email Templates UUID FK Columns

PhoenixKit.Migrations.Postgres.V61

V61: UUID Column Safety Net for Tables Missed by V40

PhoenixKit.Migrations.Postgres.V62

V62 — Rename UUID-type columns from `_id` suffix to `_uuid` suffix.

PhoenixKit.Migrations.Postgres.V63

V63: UUID Companion Column Safety Net — Round 2

PhoenixKit.Migrations.Postgres.V64

V64: Fix user token check constraint for UUID-only inserts.

PhoenixKit.Migrations.Postgres.V65

V65: Rename SubscriptionPlan → SubscriptionType

PhoenixKit.Migrations.Postgres.V66

V66: Make legacy user_id columns nullable on posts module tables.

PhoenixKit.Migrations.Postgres.V67

V67: Make all remaining legacy NOT NULL integer FK columns nullable.

PhoenixKit.Migrations.Postgres.V68

V68: Allow NULL slug for timestamp-mode publishing posts

PhoenixKit.Migrations.Postgres.V69

V69: Make legacy integer FK columns nullable on role tables.

PhoenixKit.Migrations.Postgres.V70

V70: Re-backfill UUID FK columns silently skipped in V56/V63.

PhoenixKit.Migrations.Postgres.V71

V71: Rename product_ids → product_uuids in shop import logs.

PhoenixKit.Migrations.Postgres.V72

V72: Rename `id` → `uuid` on Category A tables + add missing FK constraints.

PhoenixKit.Migrations.Postgres.V73

V73: Pre-drop prerequisites for Category B tables.

PhoenixKit.Migrations.Postgres.V74

V74: Drop integer `id`/`_id` columns, promote `uuid` to PK on Category B tables.

PhoenixKit.Migrations.Postgres.V75

V75: Fix missing/wrong DEFAULT on `uuid` PK columns, drop orphaned sequence.

PhoenixKit.Migrations.Postgres.V76

V76: Rename stale `_id` columns/keys to `_uuid`.

PhoenixKit.Migrations.Postgres.V77

V77: Rename Tickets module settings keys and permission module_key to customer_service.

PhoenixKit.Migrations.Postgres.V78

V78: Add missing columns to AI tables from V41.

PhoenixKit.Migrations.Postgres.V79

V79: Newsletters Module — Database Tables

PhoenixKit.Migrations.Postgres.V80

V80: Emails Module i18n — JSON language fields

PhoenixKit.Migrations.Postgres.V81

V81: Add position column to entity_data for manual reordering support.

PhoenixKit.Migrations.Postgres.V82

V82: Add metadata JSONB column to comments.

PhoenixKit.Migrations.Postgres.V83

V83: Add status column to publishing_groups.

PhoenixKit.Migrations.Postgres.V84

V84: Rename mailing tables to newsletters.

PhoenixKit.Migrations.Postgres.V85

V85: Add system_prompt field to AI prompts table.

PhoenixKit.Migrations.Postgres.V86

V86: Add Document Creator tables.

PhoenixKit.Migrations.Postgres.V87

V87: Add Catalogue tables.

PhoenixKit.Migrations.Postgres.V88

V88: Publishing schema V2 — restructure posts/versions/contents.

PhoenixKit.Migrations.Postgres.V89

V89: Catalogue pricing — rename price to base_price, add markup_percentage.

PhoenixKit.Migrations.UUIDFKColumns

Adds UUID FK columns alongside integer FKs across PhoenixKit tables.

PhoenixKit.Migrations.UUIDRepair

Repairs missing UUID columns for databases upgrading from PhoenixKit < 1.7.0.

PhoenixKit.Module

Behaviour for PhoenixKit feature modules (internal and external).

PhoenixKit.ModuleDiscovery

Zero-config auto-discovery of external PhoenixKit modules.

PhoenixKit.ModuleRegistry

Runtime registry of all PhoenixKit modules (internal and external).

PhoenixKit.Modules.CustomerService

Context for managing support tickets, comments, and attachments.

PhoenixKit.Modules.CustomerService.Events

PubSub events for PhoenixKit Customer Service system.

PhoenixKit.Modules.CustomerService.Ticket

Schema for support tickets.

PhoenixKit.Modules.CustomerService.TicketAttachment

Junction schema for ticket and comment attachments.

PhoenixKit.Modules.CustomerService.TicketComment

Schema for ticket comments with internal notes support.

PhoenixKit.Modules.CustomerService.TicketStatusHistory

Schema for ticket status change audit trail.

PhoenixKit.Modules.CustomerService.Web.Details

LiveView for displaying ticket details with comments and status management.

PhoenixKit.Modules.CustomerService.Web.Edit

LiveView for creating and editing support tickets.

PhoenixKit.Modules.CustomerService.Web.List

LiveView for displaying and managing support tickets in PhoenixKit admin panel.

PhoenixKit.Modules.CustomerService.Web.New

LiveView for creating new support tickets from admin panel.

PhoenixKit.Modules.CustomerService.Web.Settings

LiveView for configuring the Tickets module settings.

PhoenixKit.Modules.CustomerService.Web.UserDetails

LiveView for displaying ticket details to the ticket owner.

PhoenixKit.Modules.CustomerService.Web.UserList

LiveView for displaying user's support tickets.

PhoenixKit.Modules.CustomerService.Web.UserNew

LiveView for creating new support tickets with file attachments.

PhoenixKit.Modules.DB

Database helpers for PhoenixKit.

PhoenixKit.Modules.DB.Listener

GenServer that listens for PostgreSQL NOTIFY events for live table updates.

PhoenixKit.Modules.DB.Web.Activity

Live activity monitor for database changes.

PhoenixKit.Modules.DB.Web.Index

Admin DB index - lists all tables with stats.

PhoenixKit.Modules.DB.Web.Show

Table detail view with paginated row browsing.

PhoenixKit.Modules.Languages

Languages management for PhoenixKit - complete language configuration in a single module.

PhoenixKit.Modules.Languages.DialectMapper

Handles mapping between base language codes (en, es) and full dialect codes (en-US, es-MX).

PhoenixKit.Modules.Languages.Language

Struct representing a language in PhoenixKit.

PhoenixKit.Modules.Maintenance

Maintenance Mode module for PhoenixKit.

PhoenixKit.Modules.Referrals

Referral code system for PhoenixKit - complete management in a single module.

PhoenixKit.Modules.Referrals.ReferralCodeUsage

ReferralCodeUsage schema for tracking referral code usage in PhoenixKit.

PhoenixKit.Modules.Referrals.Web.Form

Referral code form LiveView for PhoenixKit admin panel.

PhoenixKit.Modules.Referrals.Web.List

User referral codes management LiveView for PhoenixKit admin panel.

PhoenixKit.Modules.Referrals.Web.Settings

Referral codes module settings LiveView for PhoenixKit admin panel.

PhoenixKit.Modules.SEO

SEO module for PhoenixKit.

PhoenixKit.Modules.Shared.Components.CTA

Call-to-action button component.

PhoenixKit.Modules.Shared.Components.Headline

Headline component for hero sections.

PhoenixKit.Modules.Shared.Components.Image

Image component with lazy loading and responsive sizing.

PhoenixKit.Modules.Shared.Components.Subheadline

Subheadline component for supporting text.

PhoenixKit.Modules.Shared.Components.Video

Responsive YouTube embed component.

PhoenixKit.Modules.Sitemap

Sitemap generation and management context for PhoenixKit.

PhoenixKit.Modules.Sitemap.Cache

Caching layer for sitemap generation.

PhoenixKit.Modules.Sitemap.FileStorage

File-based storage for sitemap XML files.

PhoenixKit.Modules.Sitemap.Generator

Main sitemap generator for PhoenixKit.

PhoenixKit.Modules.Sitemap.HtmlGenerator

HTML sitemap renderer for PhoenixKit.

PhoenixKit.Modules.Sitemap.RouteResolver

Resolves actual routes from parent application router.

PhoenixKit.Modules.Sitemap.SchedulerWorker

Oban worker for scheduled sitemap regeneration.

PhoenixKit.Modules.Sitemap.SitemapFile

Struct representing a generated sitemap file's metadata.

PhoenixKit.Modules.Sitemap.Sources.Posts

Posts source for sitemap generation.

PhoenixKit.Modules.Sitemap.Sources.Publishing

Publishing source for sitemap generation.

PhoenixKit.Modules.Sitemap.Sources.RouterDiscovery

Router Discovery source for sitemap generation.

PhoenixKit.Modules.Sitemap.Sources.Shop

Shop source for sitemap generation.

PhoenixKit.Modules.Sitemap.Sources.Source

Behaviour for sitemap data sources.

PhoenixKit.Modules.Sitemap.Sources.Static

Static routes source for sitemap generation.

PhoenixKit.Modules.Sitemap.UrlEntry

Struct representing a single URL entry in sitemap.

PhoenixKit.Modules.Sitemap.Web.Controller

Controller for serving XML sitemaps with XSL styling.

PhoenixKit.Modules.Sitemap.Web.Settings

LiveView for sitemap configuration and management.

PhoenixKit.Modules.Storage

Storage context for managing files, buckets, and dimensions.

PhoenixKit.Modules.Storage.Bucket

Schema for storage provider configurations.

PhoenixKit.Modules.Storage.Dimension

Schema for dimension presets for automatic file variant generation.

PhoenixKit.Modules.Storage.File

Schema for original file uploads.

PhoenixKit.Modules.Storage.FileInstance

Schema for file variants (thumbnails, resizes, video qualities).

PhoenixKit.Modules.Storage.FileLocation

Schema for physical storage locations (redundancy tracking).

PhoenixKit.Modules.Storage.FileServer

File serving logic with multi-location failover support.

PhoenixKit.Modules.Storage.ImageProcessor

ImageMagick-based image processing module.

PhoenixKit.Modules.Storage.Manager

Storage manager for handling file operations with redundancy and failover.

PhoenixKit.Modules.Storage.PdfProcessor

Poppler-based PDF processing module.

PhoenixKit.Modules.Storage.ProcessFileJob

Oban job for background processing of uploaded files.

PhoenixKit.Modules.Storage.Provider

Behavior for storage providers.

PhoenixKit.Modules.Storage.ProviderRegistry

Registry for storage providers.

PhoenixKit.Modules.Storage.Providers.Local

Local filesystem storage provider.

PhoenixKit.Modules.Storage.Providers.S3

AWS S3 storage provider.

PhoenixKit.Modules.Storage.TestJob

Simple test job to verify Oban is working

PhoenixKit.Modules.Storage.URLSigner

Token-based URL signing for secure file serving.

PhoenixKit.Modules.Storage.VariantGenerator

Variant generation system for images and videos.

PhoenixKit.Modules.Storage.Workers.DeleteOrphanedFileJob

Oban job for deleting a single orphaned file.

PhoenixKit.PubSub.Manager

PubSub Manager for PhoenixKit admin live updates.

PhoenixKit.PubSubHelper

Helper for dynamically resolving the PubSub server to use.

PhoenixKit.RepoHelper

Helper for dynamically resolving the repository to use.

PhoenixKit.ScheduledJobs

Context module for managing scheduled jobs.

PhoenixKit.ScheduledJobs.Handler

Behaviour for scheduled job handlers.

PhoenixKit.ScheduledJobs.ScheduledJob

Schema for scheduled jobs.

PhoenixKit.ScheduledJobs.Workers.ProcessScheduledJobsWorker

Oban worker that processes pending scheduled jobs.

PhoenixKit.Settings

The Settings context for system configuration management.

PhoenixKit.Settings.Events

PubSub helpers for broadcasting settings updates in real-time.

PhoenixKit.Settings.Queries

Ecto queries for Settings context.

PhoenixKit.Settings.Setting

Setting schema for PhoenixKit system settings.

PhoenixKit.Settings.Setting.SettingsForm

Settings form schema for PhoenixKit system settings validation.

PhoenixKit.Supervisor

Supervisor for all PhoenixKit workers.

PhoenixKit.System.Dependencies

System dependency checker for PhoenixKit.

PhoenixKit.ThemeConfig

Theme configuration utilities for PhoenixKit's DaisyUI integration.

PhoenixKit.Users.AdminNote

Schema for admin notes about users.

PhoenixKit.Users.Auth

The Auth context for user authentication and management.

PhoenixKit.Users.Auth.Scope

Scope module for encapsulating PhoenixKit authentication state.

PhoenixKit.Users.Auth.User

User schema for PhoenixKit authentication system.

PhoenixKit.Users.Auth.UserNotifier

User notification system for PhoenixKit authentication workflows.

PhoenixKit.Users.Auth.UserToken

User token schema for PhoenixKit authentication system.

PhoenixKit.Users.CustomFields

Context for managing custom user field definitions.

PhoenixKit.Users.CustomFields.Events

PubSub event broadcasting for custom field changes.

PhoenixKit.Users.MagicLink

Magic Link authentication system for PhoenixKit.

PhoenixKit.Users.MagicLinkRegistration

Two-step user registration via Magic Link email.

PhoenixKit.Users.OAuth

OAuth authentication context for PhoenixKit.

PhoenixKit.Users.OAuthAvailability

Checks OAuth availability and configured providers.

PhoenixKit.Users.OAuthConfig

Runtime OAuth configuration management using database credentials.

PhoenixKit.Users.OAuthProvider

OAuth Provider schema for external authentication providers.

PhoenixKit.Users.Permissions

Context for module-level permissions in PhoenixKit.

PhoenixKit.Users.RateLimiter

Rate limiting for authentication endpoints to prevent brute-force attacks.

PhoenixKit.Users.RateLimiter.Backend

Hammer 7.x backend for rate limiting.

PhoenixKit.Users.Role

Role schema for PhoenixKit authorization system.

PhoenixKit.Users.RoleAssignment

Role assignment schema for PhoenixKit authorization system.

PhoenixKit.Users.RolePermission

Schema for module-level permissions assigned to roles.

PhoenixKit.Users.Roles

API for managing user roles in PhoenixKit.

PhoenixKit.Users.ScopeNotifier

Handles PubSub notifications for user scope refreshes.

PhoenixKit.Users.Sessions

Context for managing user sessions in PhoenixKit.

PhoenixKit.Users.TableColumns

Table column configuration for user management dashboard.

PhoenixKit.Utils.CountryData

Wrapper for BeamLabCountries with country data utility functions.

PhoenixKit.Utils.Date

Date and time formatting utilities for PhoenixKit.

PhoenixKit.Utils.Geolocation

IP Geolocation utilities for PhoenixKit.

PhoenixKit.Utils.HeroIcons

Curated list of Heroicons for use in the application. Icons are grouped by category for easy browsing.

PhoenixKit.Utils.HtmlSanitizer

HTML sanitization for rich text content in entities.

PhoenixKit.Utils.IpAddress

Utilities for extracting and formatting IP addresses.

PhoenixKit.Utils.Multilang

Multi-language data transformation helpers for entity data JSONB.

PhoenixKit.Utils.Number

Number formatting utilities for PhoenixKit.

PhoenixKit.Utils.PhoenixVersion

Utilities for detecting and working with Phoenix framework versions.

PhoenixKit.Utils.Routes

Utility functions for working with PhoenixKit routes and URLs.

PhoenixKit.Utils.SessionFingerprint

Session fingerprinting utilities for preventing session hijacking.

PhoenixKit.Utils.Slug

Helpers for generating consistent, URL-friendly slugs across PhoenixKit.

PhoenixKit.Utils.UUID

Utilities for working with UUIDs.

PhoenixKit.Workers.OAuthConfigLoader

GenServer worker that ensures OAuth configuration is loaded from database before any OAuth requests are processed.

PhoenixKitWeb

The web interface for PhoenixKit.

PhoenixKitWeb.AdminEditHelper

Universal admin edit URL helper. Assigns admin_edit_url and admin_edit_label to conn/socket if user is admin. Works with both Plug.Conn (controllers) and Phoenix.LiveView.Socket (LiveViews).

PhoenixKitWeb.AssetsController

Controller for serving PhoenixKit static assets.

PhoenixKitWeb.AuthRouter

Legacy authentication router for PhoenixKit.

PhoenixKitWeb.Components.AdminNav

Admin navigation components for the PhoenixKit admin panel. Provides consistent navigation elements for both desktop sidebar and mobile drawer.

PhoenixKitWeb.Components.AuthPageWrapper

Wrapper component for all auth pages (login, registration, etc.).

PhoenixKitWeb.Components.Core.AWSCredentialsVerify

AWS Credentials Verification Component.

PhoenixKitWeb.Components.Core.AWSRegionSelect

AWS Region Select Component.

PhoenixKitWeb.Components.Core.Accordion

Accordion Component for collapsible content sections.

PhoenixKitWeb.Components.Core.AdminPageHeader

Provides a unified admin page header component with optional back button, title, subtitle, and action slots.

PhoenixKitWeb.Components.Core.Badge

Provides badge UI components for status, roles, and labels.

PhoenixKitWeb.Components.Core.Button

Provides a button UI component.

PhoenixKitWeb.Components.Core.Checkbox

Provides a default checkbox UI component.

PhoenixKitWeb.Components.Core.DevNotice

Development mode notice component for the local mailbox.

PhoenixKitWeb.Components.Core.DraggableList

A reusable drag-and-drop sortable component supporting both grid and list layouts.

PhoenixKitWeb.Components.Core.EmailActivityBadges

Provides email activity badges component for chronological event display.

PhoenixKitWeb.Components.Core.EmailStatusBadge

Provides email status badge components for email tracking system.

PhoenixKitWeb.Components.Core.EventTimelineItem

Provides event timeline item component for email event visualization.

PhoenixKitWeb.Components.Core.FileDisplay

Components for displaying file-related information.

PhoenixKitWeb.Components.Core.FileUpload

Reusable file upload component for PhoenixKit.

PhoenixKitWeb.Components.Core.Flash

Provides flash UI components.

PhoenixKitWeb.Components.Core.FormFieldError

Provides an error UI component for form components.

PhoenixKitWeb.Components.Core.FormFieldLabel

Provides a label UI component for form components.

PhoenixKitWeb.Components.Core.Header

Provides a header UI component.

PhoenixKitWeb.Components.Core.HeroStatCard

Provides a large hero statistics card UI component for prominent dashboard metrics.

PhoenixKitWeb.Components.Core.Icon

Provides a hero icon UI component.

PhoenixKitWeb.Components.Core.Icons

Provides icons for other components and interfaces.

PhoenixKitWeb.Components.Core.Input

Provides inputs UI components.

PhoenixKitWeb.Components.Core.LanguageSwitcher

Language switcher component for frontend and admin applications.

PhoenixKitWeb.Components.Core.MaintenancePage

Displays a full-page maintenance message.

PhoenixKitWeb.Components.Core.Markdown

Renders markdown content safely with consistent styling.

PhoenixKitWeb.Components.Core.MarkdownContent

Renders markdown content with consistent styling across the application.

PhoenixKitWeb.Components.Core.MarkdownEditor

Reusable markdown editor LiveComponent with cursor tracking, markdown formatting toolbar, component insertion, and unsaved changes protection.

PhoenixKitWeb.Components.Core.MediaThumbnail

Provides a component for resolving and rendering media file thumbnail URLs.

PhoenixKitWeb.Components.Core.MessageTagBadge

Provides message tag badge component for email system.

PhoenixKitWeb.Components.Core.Modal

A reusable modal dialog component with robust features.

PhoenixKitWeb.Components.Core.ModuleCard

Provides a module card UI component for the Modules Overview page.

PhoenixKitWeb.Components.Core.NumberFormatter

Number formatting components for PhoenixKit.

PhoenixKitWeb.Components.Core.OAuthCheckbox

Reusable component for OAuth provider checkboxes with conditional styling.

PhoenixKitWeb.Components.Core.OAuthProvider

Reusable component for OAuth provider credential forms.

PhoenixKitWeb.Components.Core.OAuthUtils

Utility components for OAuth functionality.

PhoenixKitWeb.Components.Core.Pagination

Pagination components for list views in PhoenixKit.

PhoenixKitWeb.Components.Core.PhoenixKitGlobals

Component that sets PhoenixKit JavaScript global variables.

PhoenixKitWeb.Components.Core.PkLink

Provides prefix-aware link components for PhoenixKit navigation.

PhoenixKitWeb.Components.Core.Select

Provides a default select UI component.

PhoenixKitWeb.Components.Core.SimpleForm

Provides a simple form UI component.

PhoenixKitWeb.Components.Core.StatCard

Provides a statistics card UI component for dashboard metrics.

PhoenixKitWeb.Components.Core.TableDefault

A basic table component with daisyUI styling.

PhoenixKitWeb.Components.Core.TableRowMenu

Dropdown action menu for table rows.

PhoenixKitWeb.Components.Core.Textarea

Provides a default textarea UI component.

PhoenixKitWeb.Components.Core.ThemeController

Shared theme controller component for admin and dashboard.

PhoenixKitWeb.Components.Core.ThemeSwitcher

Provides a theme switcher UI component.

PhoenixKitWeb.Components.Core.TimeDisplay

Provides time and date display components with relative and absolute formatting.

PhoenixKitWeb.Components.Core.UserDashboardHeader

Provides a unified user dashboard header component with title, subtitle, and action slots.

PhoenixKitWeb.Components.Core.UserInfo

Provides user information display components.

PhoenixKitWeb.Components.Dashboard.AdminSidebar

Admin sidebar component for the PhoenixKit admin panel.

PhoenixKitWeb.Components.Dashboard.Badge

Badge component for dashboard tab indicators.

PhoenixKitWeb.Components.Dashboard.ContextSelector

Context selector dropdown component for dashboard navigation.

PhoenixKitWeb.Components.Dashboard.LiveTabs

LiveView integration for dashboard tabs with real-time updates.

PhoenixKitWeb.Components.Dashboard.MultiContextSelector

Wrapper component for rendering multiple context selectors.

PhoenixKitWeb.Components.Dashboard.Sidebar

Sidebar component for the user dashboard.

PhoenixKitWeb.Components.Dashboard.TabItem

Tab item component for dashboard navigation.

PhoenixKitWeb.Components.LanguageSwitcher

Shared language switcher component for PhoenixKit.

PhoenixKitWeb.Components.LayoutWrapper

Dynamic layout wrapper component for Phoenix v1.7- and v1.8+ compatibility.

PhoenixKitWeb.Components.MultilangForm

Shared multilang form components and helpers for PhoenixKit modules.

PhoenixKitWeb.Components.OAuthButtons

OAuth authentication buttons component for Google and Apple Sign-In.

PhoenixKitWeb.Components.UserDashboardNav

User dashboard navigation components for the PhoenixKit user dashboard. Provides navigation elements specifically for user dashboard pages.

PhoenixKitWeb.ContextController

Controller for handling dashboard context switching.

PhoenixKitWeb.Dashboard.ContextProvider

LiveView on_mount hook for loading dashboard contexts.

PhoenixKitWeb.Dashboard.TabsInitializer

LiveView on_mount hook for initializing dashboard tabs with context-aware badge values.

PhoenixKitWeb.Endpoint
PhoenixKitWeb.ErrorHTML

This module is invoked by your endpoint in case of errors on HTML requests.

PhoenixKitWeb.ErrorJSON

This module is invoked by your endpoint in case of errors on JSON requests.

PhoenixKitWeb.FileController

File serving controller with signed URL support.

PhoenixKitWeb.Gettext

A module providing Internationalization with a gettext-based API.

PhoenixKitWeb.Helpers.MediaSelectorHelper

Helper functions for integrating the media selector component.

PhoenixKitWeb.Integration

Integration helpers for adding PhoenixKit to Phoenix applications.

PhoenixKitWeb.LayoutHelpers

Helper functions for working with PhoenixKit layouts efficiently.

PhoenixKitWeb.Layouts

This module holds different layouts used by your application.

PhoenixKitWeb.Live.Components.MediaSelectorModal

Media selector modal component.

PhoenixKitWeb.Live.Components.UserMediaSelectorModal

User-scoped media selector modal.

PhoenixKitWeb.Live.Components.UserSettings

Reusable LiveComponent for user settings management.

PhoenixKitWeb.Live.Dashboard

Admin dashboard LiveView for PhoenixKit.

PhoenixKitWeb.Live.Dashboard.Index

Dashboard Index LiveView for PhoenixKit.

PhoenixKitWeb.Live.Dashboard.Settings

Settings LiveView for PhoenixKit Dashboard.

PhoenixKitWeb.Live.Modules

Admin modules management LiveView for PhoenixKit.

PhoenixKitWeb.Live.Modules.Jobs.Index

LiveView for viewing jobs.

PhoenixKitWeb.Live.Modules.Languages

Languages module settings LiveView for PhoenixKit admin panel.

PhoenixKitWeb.Live.Modules.Maintenance.Settings

Settings page for the Maintenance module.

PhoenixKitWeb.Live.Modules.Storage.BucketForm

Bucket form LiveView for storage bucket management.

PhoenixKitWeb.Live.Modules.Storage.DimensionForm

Dimension form LiveView for storage dimension management.

PhoenixKitWeb.Live.Modules.Storage.Dimensions

Storage dimensions management LiveView.

PhoenixKitWeb.Live.Modules.Storage.Settings

Storage settings management LiveView for PhoenixKit.

PhoenixKitWeb.Live.Settings

Admin settings management LiveView for PhoenixKit.

PhoenixKitWeb.Live.Settings.Authorization

Authorization settings management LiveView for PhoenixKit.

PhoenixKitWeb.Live.Settings.Organization

Organization settings management LiveView for PhoenixKit.

PhoenixKitWeb.Live.Settings.SEO

SEO settings management LiveView for PhoenixKit.

PhoenixKitWeb.Live.Settings.Users

User-related settings management LiveView for PhoenixKit.

PhoenixKitWeb.Live.Users.LiveSessions

Real-time session monitoring dashboard for the PhoenixKit admin panel.

PhoenixKitWeb.Live.Users.Media

Media management LiveView for PhoenixKit admin panel.

PhoenixKitWeb.Live.Users.MediaDetail

Single media file detail view for PhoenixKit admin panel.

PhoenixKitWeb.Live.Users.MediaSelector

Generic media selector LiveView.

PhoenixKitWeb.Live.Users.PermissionsMatrix

Interactive permissions matrix view for PhoenixKit admin panel.

PhoenixKitWeb.Live.Users.Roles

Role management LiveView for PhoenixKit admin panel.

PhoenixKitWeb.Live.Users.Sessions

Live component for managing active user sessions in the PhoenixKit admin panel.

PhoenixKitWeb.Live.Users.UserDetails

LiveView for displaying detailed user information.

PhoenixKitWeb.Live.Users.Users

User management LiveView for PhoenixKit admin panel.

PhoenixKitWeb.PagesHTML

Renders public pages from markdown files.

PhoenixKitWeb.Plugs.EnsureOAuthConfig

Plug that ensures OAuth credentials are loaded into Application env before OAuth requests.

PhoenixKitWeb.Plugs.EnsureOAuthScheme

Ensures correct HTTPS scheme for OAuth callback URL generation behind reverse proxies.

PhoenixKitWeb.Plugs.Integration

Central integration plug for PhoenixKit.

PhoenixKitWeb.Plugs.MaintenanceMode

Plug that enforces maintenance mode for non-admin users.

PhoenixKitWeb.Plugs.RequestTimer

A plug that logs detailed timing information for requests.

PhoenixKitWeb.Router

PhoenixKit library router.

PhoenixKitWeb.Routes.CustomerServiceRoutes

Tickets module routes.

PhoenixKitWeb.Routes.ReferralsRoutes

Referral codes module routes.

PhoenixKitWeb.UploadController

File upload controller for handling multipart uploads.

PhoenixKitWeb.Users.Auth

Authentication and authorization plugs for PhoenixKit user management.

PhoenixKitWeb.Users.Confirmation

LiveView for email confirmation.

PhoenixKitWeb.Users.ConfirmationInstructions

LiveView for resending email confirmation instructions.

PhoenixKitWeb.Users.ForgotPassword

LiveView for password reset request.

PhoenixKitWeb.Users.Login

LiveView for user authentication.

PhoenixKitWeb.Users.MagicLink

LiveView for magic link authentication.

PhoenixKitWeb.Users.MagicLinkRegistration

LiveView for magic link registration completion form.

PhoenixKitWeb.Users.MagicLinkRegistrationRequest

LiveView for requesting magic link registration.

PhoenixKitWeb.Users.MagicLinkRegistrationVerify

Controller for handling magic link registration verification.

PhoenixKitWeb.Users.MagicLinkVerify

Controller for handling magic link verification and authentication.

PhoenixKitWeb.Users.OAuth

OAuth authentication controller using Ueberauth with dynamic provider configuration.

PhoenixKitWeb.Users.Registration

LiveView for user registration.

PhoenixKitWeb.Users.ResetPassword

LiveView for password reset functionality.

PhoenixKitWeb.Users.Session

Controller for handling user session management.

PhoenixKitWeb.Users.UserForm

LiveView for creating and editing users in the admin interface.

## Mix Tasks

mix phoenix_kit.assets.rebuild

Rebuilds assets for PhoenixKit using standard Phoenix asset pipeline.

mix phoenix_kit.cleanup_orphaned_files

Finds and optionally deletes orphaned media files in PhoenixKit Storage.

mix phoenix_kit.doctor

Diagnoses PhoenixKit installation, migration, and runtime issues.

mix phoenix_kit.gen.admin.page

Igniter task that generates admin page with automatic route registration.

mix phoenix_kit.gen.migration

Generate a PhoenixKit versioned migration for the parent application.

mix phoenix_kit.gen.user.dashboard

Igniter task that generates a user dashboard page with tab configuration.

mix phoenix_kit.install

Igniter installer for PhoenixKit.

mix phoenix_kit.modernize_layouts

Modernizes PhoenixKit layout integration for Phoenix v1.8+ compatibility.

mix phoenix_kit.status

Shows comprehensive status of PhoenixKit installation.

mix phoenix_kit.update

Igniter-based updater for PhoenixKit.

mix phoenix_kit_templates

Template definitions for PhoenixKit demo pages.