Search documentation of phoenix_kit

# API Reference phoenix_kit v#1.6.19

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.AuditLog

Context for managing audit logs in PhoenixKit.

PhoenixKit.AuditLog.Entry

Schema for audit log entries.

PhoenixKit.Blogging.Renderer

Renders blog post markdown to HTML with caching support.

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.UeberAuth

Ueberauth configuration management for PhoenixKit.

PhoenixKit.Emails

Email system for PhoenixKit - main API module.

PhoenixKit.Emails.ApplicationIntegration

Helpers for integrating PhoenixKit Email Tracking into parent applications.

PhoenixKit.Emails.Archiver

Archive and compress old email tracking data for optimal storage.

PhoenixKit.Emails.EmailBlocklist

Email blocklist schema for storing blocked email addresses.

PhoenixKit.Emails.Event

Email event schema for managing delivery events in PhoenixKit.

PhoenixKit.Emails.Interceptor

Email interceptor for logging outgoing emails in PhoenixKit.

PhoenixKit.Emails.Log

Email logging for PhoenixKit - comprehensive logging in a single module.

PhoenixKit.Emails.Metrics

Local metrics and analytics for PhoenixKit email tracking.

PhoenixKit.Emails.RateLimiter

Rate limiting and spam protection for the email system.

PhoenixKit.Emails.SQSProcessor

Processor for handling email events from AWS SQS messages.

PhoenixKit.Emails.SQSWorker

SQS Worker for processing email events from AWS SQS Queue.

PhoenixKit.Emails.Supervisor

Supervisor for PhoenixKit email tracking system.

PhoenixKit.Emails.TableColumns

Manages table column customization for email logs display.

PhoenixKit.Emails.Template

Email template schema for managing reusable email templates.

PhoenixKit.Emails.Templates

Context module for managing email templates.

PhoenixKit.Emails.Utils

Utility functions for email handling in PhoenixKit.

PhoenixKit.Entities

Dynamic entity system for PhoenixKit - WordPress ACF equivalent.

PhoenixKit.Entities.EntityData

Entity data records for PhoenixKit entities system.

PhoenixKit.Entities.Events

PubSub helpers for coordinating real-time entity updates.

PhoenixKit.Entities.FieldTypes

Field type definitions and utilities for the Entities system.

PhoenixKit.Entities.FormBuilder

Dynamic form builder for entity data forms.

PhoenixKit.Entities.HtmlSanitizer

HTML sanitization for rich text content in entities.

PhoenixKit.Entities.Presence

Presence tracking for collaborative entity editing.

PhoenixKit.Entities.PresenceHelpers

Helper functions for collaborative editing with Phoenix.Presence.

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.DemoFiles

Handles copying demo test files for PhoenixKit installation.

PhoenixKit.Install.FinchSetup

Handles automatic Finch and HTTP client setup for PhoenixKit installation.

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 notices 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.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 (WordPress ACF-like)

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.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.Maintenance

Maintenance Mode module for PhoenixKit.

PhoenixKit.Modules.SEO

SEO module for PhoenixKit.

PhoenixKit.Modules.Storage

Storage Module for PhoenixKit.

PhoenixKit.Pages

Pages module for file-based content management.

PhoenixKit.Pages.FileOperations

Filesystem operations for Pages module.

PhoenixKit.Pages.Metadata

Metadata management for Pages module.

PhoenixKit.Pages.Paths

Path utilities for Pages module.

PhoenixKit.Pages.Renderer

Simple markdown rendering for Pages module.

PhoenixKit.PubSub.Manager

PubSub Manager for PhoenixKit admin live updates.

PhoenixKit.ReferralCodeUsage

ReferralCodeUsage schema for tracking referral code usage in PhoenixKit.

PhoenixKit.ReferralCodes

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

PhoenixKit.RepoHelper

Helper for dynamically resolving the repository to use.

PhoenixKit.Settings

The Settings context for system configuration management.

PhoenixKit.Settings.Events

PubSub helpers for broadcasting settings updates in real-time.

PhoenixKit.Settings.Setting

Setting schema for PhoenixKit system settings.

PhoenixKit.Settings.Setting.SettingsForm

Settings form schema for PhoenixKit system settings validation.

PhoenixKit.Sitemap

Sitemap generation and management context for PhoenixKit.

PhoenixKit.Sitemap.Cache

ETS-based caching layer for sitemap generation.

PhoenixKit.Sitemap.Generator

Main sitemap generator for PhoenixKit.

PhoenixKit.Sitemap.RouteResolver

Resolves actual routes from parent application router.

PhoenixKit.Sitemap.SchedulerWorker

Oban worker for scheduled sitemap regeneration.

PhoenixKit.Sitemap.Sources.Blogging

Blogging source for sitemap generation.

PhoenixKit.Sitemap.Sources.Entities

Entities source for sitemap generation.

PhoenixKit.Sitemap.Sources.RouterDiscovery

Router Discovery source for sitemap generation.

PhoenixKit.Sitemap.Sources.Source

Behaviour for sitemap data sources.

PhoenixKit.Sitemap.Sources.Static

Static routes source for sitemap generation.

PhoenixKit.Sitemap.UrlEntry

Struct representing a single URL entry in sitemap.

PhoenixKit.Storage

Storage context for managing files, buckets, and dimensions.

PhoenixKit.Storage.Bucket

Schema for storage provider configurations.

PhoenixKit.Storage.Dimension

Schema for dimension presets for automatic file variant generation.

PhoenixKit.Storage.File

Schema for original file uploads.

PhoenixKit.Storage.FileInstance

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

PhoenixKit.Storage.FileLocation

Schema for physical storage locations (redundancy tracking).

PhoenixKit.Storage.FileServer

File serving logic with multi-location failover support.

PhoenixKit.Storage.ImageProcessor

ImageMagick-based image processing module.

PhoenixKit.Storage.Manager

Storage manager for handling file operations with redundancy and failover.

PhoenixKit.Storage.Provider

Behavior for storage providers.

PhoenixKit.Storage.ProviderRegistry

Registry for storage providers.

PhoenixKit.Storage.Providers.Local

Local filesystem storage provider.

PhoenixKit.Storage.Providers.S3

AWS S3 storage provider.

PhoenixKit.Storage.URLSigner

Token-based URL signing for secure file serving.

PhoenixKit.Storage.VariantGenerator

Variant generation system for images and videos.

PhoenixKit.Storage.Workers.ProcessFileJob

Oban job for background processing of uploaded files.

PhoenixKit.Storage.Workers.TestJob

Simple test job to verify Oban is working

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.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.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.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.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.IpAddress

Utilities for extracting and formatting IP addresses.

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.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.AuthRouter

Legacy authentication router for PhoenixKit.

PhoenixKitWeb.BlogController

Public blog post display controller.

PhoenixKitWeb.BlogHTML

HTML rendering functions for BlogController.

PhoenixKitWeb.Components.AdminNav

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

PhoenixKitWeb.Components.Blogging.CTA

Call-to-action button component.

PhoenixKitWeb.Components.Blogging.EntityForm

Embeddable entity form component for blogging pages. Renders a public submission form based on entity configuration.

PhoenixKitWeb.Components.Blogging.Headline

Headline component for hero sections.

PhoenixKitWeb.Components.Blogging.Hero

Hero section component with multiple variants.

PhoenixKitWeb.Components.Blogging.Image

Image component with lazy loading and responsive sizing.

PhoenixKitWeb.Components.Blogging.Page

Root page component wrapper.

PhoenixKitWeb.Components.Blogging.Subheadline

Subheadline component for supporting text.

PhoenixKitWeb.Components.Blogging.Video

Responsive YouTube embed component.

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.Badge

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

PhoenixKitWeb.Components.Core.BlogLanguageSwitcher

Unified language switcher component for blog posts.

PhoenixKitWeb.Components.Core.Button

Provides a button UI component.

PhoenixKitWeb.Components.Core.Checkbox

Provides a default checkbox UI component.

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 applications.

PhoenixKitWeb.Components.Core.MaintenancePage

Displays a full-page maintenance message.

PhoenixKitWeb.Components.Core.MessageTagBadge

Provides message tag badge component for email system.

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.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.Textarea

Provides a default textarea UI component.

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.UserInfo

Provides user information display components.

PhoenixKitWeb.Components.LayoutWrapper

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

PhoenixKitWeb.Components.OAuthButtons

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

PhoenixKitWeb.Controllers.EmailExportController

Controller for exporting email tracking data to CSV format.

PhoenixKitWeb.Controllers.EmailWebhookController

Secure webhook controller for AWS SNS email events.

PhoenixKitWeb.Endpoint
PhoenixKitWeb.EntityFormController

Controller for handling public entity form submissions.

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.Layouts

This module holds different layouts used by your application.

PhoenixKitWeb.Live.Components.MediaSelectorModal

Media selector modal component.

PhoenixKitWeb.Live.Dashboard

Admin dashboard LiveView for PhoenixKit.

PhoenixKitWeb.Live.Modules

Admin modules management LiveView for PhoenixKit.

PhoenixKitWeb.Live.Modules.Blogging

Blogging module for managing site blogs and their posts.

PhoenixKitWeb.Live.Modules.Blogging.Blog

Lists posts for a blog and provides creation actions.

PhoenixKitWeb.Live.Modules.Blogging.Edit

LiveView for editing blog metadata such as display name and slug.

PhoenixKitWeb.Live.Modules.Blogging.Editor

Markdown editor for blogging posts.

PhoenixKitWeb.Live.Modules.Blogging.Index

Blogging module overview dashboard. Provides high-level stats, quick actions, and guidance for administrators.

PhoenixKitWeb.Live.Modules.Blogging.Metadata

Metadata helpers for .phk (PhoenixKit) blogging posts.

PhoenixKitWeb.Live.Modules.Blogging.New

LiveView for creating a new blog workspace.

PhoenixKitWeb.Live.Modules.Blogging.PageBuilder

Rendering pipeline for .phk (PhoenixKit) page files.

PhoenixKitWeb.Live.Modules.Blogging.PageBuilder.Parser

Parses .phk (PhoenixKit) XML-style markup into an AST.

PhoenixKitWeb.Live.Modules.Blogging.PageBuilder.Renderer

Renders AST nodes to HTML by delegating to component modules.

PhoenixKitWeb.Live.Modules.Blogging.Preview

Preview rendering for .phk blogging posts.

PhoenixKitWeb.Live.Modules.Blogging.Settings

Admin configuration for site blogs.

PhoenixKitWeb.Live.Modules.Blogging.Storage

Filesystem storage helpers for blogging posts.

PhoenixKitWeb.Live.Modules.Emails.Blocklist

LiveView for managing email blocklist and blocked addresses.

PhoenixKitWeb.Live.Modules.Emails.Details

LiveView for displaying detailed information about a specific email log.

PhoenixKitWeb.Live.Modules.Emails.EmailTracking

LiveView for email tracking system settings and configuration.

PhoenixKitWeb.Live.Modules.Emails.Emails

LiveView for displaying and managing emails in PhoenixKit admin panel.

PhoenixKitWeb.Live.Modules.Emails.Metrics

LiveView for email metrics and analytics dashboard.

PhoenixKitWeb.Live.Modules.Emails.Queue

LiveView for email queue monitoring and rate limit management.

PhoenixKitWeb.Live.Modules.Emails.Settings

LiveView for email system configuration and settings management.

PhoenixKitWeb.Live.Modules.Emails.TemplateEditor

LiveView for creating and editing email templates in PhoenixKit admin panel.

PhoenixKitWeb.Live.Modules.Emails.Templates

LiveView for displaying and managing email templates in PhoenixKit admin panel.

PhoenixKitWeb.Live.Modules.Entities.DataForm

LiveView for creating and editing entity data records. Provides dynamic form interface based on entity schema definition.

PhoenixKitWeb.Live.Modules.Entities.DataNavigator

LiveView for browsing and managing entity data records. Provides table view with pagination, search, filtering, and bulk operations.

PhoenixKitWeb.Live.Modules.Entities.DataView

LiveView for viewing entity data records. Displays data with public form fields separated from other fields. Uses FormBuilder with disabled fields for the form section.

PhoenixKitWeb.Live.Modules.Entities.Entities

LiveView for listing and managing all entities. Provides interface for viewing, publishing, and deleting entity schemas.

PhoenixKitWeb.Live.Modules.Entities.EntitiesSettings

LiveView for managing entities system settings and configuration. Provides interface for enabling/disabling entities module and viewing statistics.

PhoenixKitWeb.Live.Modules.Entities.EntityForm

LiveView for creating and editing entity schemas. Provides form interface for defining entity fields, types, and validation rules.

PhoenixKitWeb.Live.Modules.Entities.Hooks

LiveView hooks for entity module pages.

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.Pages.Editor

Full-screen editor for Pages files.

PhoenixKitWeb.Live.Modules.Pages.Pages

LiveView for Pages file management interface.

PhoenixKitWeb.Live.Modules.Pages.Settings

LiveView for configuring public-facing Pages module settings, including the custom 404 fallback experience.

PhoenixKitWeb.Live.Modules.Pages.View

Rendered view for Pages markdown files.

PhoenixKitWeb.Live.Modules.ReferralCodes

Referral codes module settings LiveView for PhoenixKit admin panel.

PhoenixKitWeb.Live.Modules.Sitemaps.Settings

LiveView for sitemap configuration and management.

PhoenixKitWeb.Live.Settings

Admin settings management LiveView for PhoenixKit.

PhoenixKitWeb.Live.Settings.SEO

SEO settings management LiveView for PhoenixKit.

PhoenixKitWeb.Live.Settings.Storage

Storage settings management LiveView for PhoenixKit.

PhoenixKitWeb.Live.Settings.Storage.BucketForm

Bucket form LiveView for storage bucket management.

PhoenixKitWeb.Live.Settings.Storage.DimensionForm

Dimension form LiveView for storage dimension management.

PhoenixKitWeb.Live.Settings.Storage.Dimensions

Storage dimensions management LiveView.

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.ReferralCodeForm

Referral code form LiveView for PhoenixKit admin panel.

PhoenixKitWeb.Live.Users.ReferralCodes

User referral codes management LiveView 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.Users

User management LiveView for PhoenixKit admin panel.

PhoenixKitWeb.PagesController
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.Router

PhoenixKit library router.

PhoenixKitWeb.SitemapController

Controller for serving XML sitemaps with XSL styling.

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.Settings

LiveView for user account settings 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.configure_aws_ses

Mix task to configure AWS SES integration for PhoenixKit email system.

mix phoenix_kit.email.cleanup

Mix task to clean up old email system logs and optimize storage.

mix phoenix_kit.email.debug_sqs

Mix task to debug SQS queue messages and analyze message ID matching issues.

mix phoenix_kit.email.export

Mix task to export email tracking data to various formats.

mix phoenix_kit.email.process_dlq

Process accumulated messages from AWS SQS Dead Letter Queue (DLQ).

mix phoenix_kit.email.send_test

Mix task to send a test email to verify email system functionality.

mix phoenix_kit.email.stats

Mix task to display comprehensive email system statistics.

mix phoenix_kit.email.test_webhook

Mix task to test email webhook functionality with sample events.

mix phoenix_kit.email.verify_config

Mix task to verify email tracking system configuration.

mix phoenix_kit.fix_missing_events

Finds and fixes email logs with missing bounce/complaint/reject events.

mix phoenix_kit.gen.migration

Generate PhoenixKit migration in parent application.

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.process_dlq

Mix task to process failed email events from AWS SQS Dead Letter Queue (DLQ).

mix phoenix_kit.process_sqs

Processes pending messages from AWS SQS queue for email events.

mix phoenix_kit.process_sqs_queue

Mix task to process email events from AWS SQS queue.

mix phoenix_kit.seed_templates

Seeds the database with system email templates.

mix phoenix_kit.status

Shows comprehensive status of PhoenixKit installation.

mix phoenix_kit.sync_email_status

Mix task to manually sync email status by AWS SES message ID.

mix phoenix_kit.update

Igniter-based updater for PhoenixKit.

mix phoenix_kit_templates

Template definitions for PhoenixKit demo pages.