PhoenixKit.Install.RateLimiterConfig (phoenix_kit v1.7.42)

Copy Markdown View Source

Handles Hammer rate limiter configuration for PhoenixKit installation.

This module provides functionality to:

  • Configure Hammer backend (ETS by default)
  • Add rate limiting configuration for PhoenixKit endpoints
  • Ensure configuration exists during updates

Summary

Functions

Adds or verifies Hammer rate limiter configuration.

Checks if Hammer configuration exists in config.exs.

Functions

add_rate_limiter_configuration(igniter)

Adds or verifies Hammer rate limiter configuration.

This function ensures that both:

  1. Hammer backend configuration exists (required for Hammer to start)
  2. PhoenixKit rate limiter settings are configured

Parameters

  • igniter - The igniter context

Returns

Updated igniter with rate limiter configuration and notices.

hammer_config_exists?(igniter)

Checks if Hammer configuration exists in config.exs.

Parameters

  • _igniter - The igniter context (unused but required for API consistency)

Returns

Boolean indicating if configuration exists.