class Kemal::Config

• Kemal::Config
• Reference
• Object

Overview

Stores all the configuration options for a Kemal application. It's a singleton and you can access it like.

Kemal.config

Defined in:

kemal/config.cr

Constant Summary

CUSTOM_HANDLERS = [] of Tuple(Int32 | ::Nil, HTTP::Handler)

ERROR_HANDLERS = {} of Int32 => (HTTP::Server::Context, Exception -> String)

EXCEPTION_HANDLERS = {} of Exception.class => (HTTP::Server::Context, Exception -> String)

FILTER_HANDLERS = [] of HTTP::Handler

HANDLERS = [] of HTTP::Handler

INSTANCE = Config.new

Constructors

• .new

Instance Method Summary

• #add_error_handler(status_code : Int32, &handler : HTTP::Server::Context, Exception -> _)

  Adds an error handler for the given HTTP status code

• #add_exception_handler(exception : Exception.class, &handler : HTTP::Server::Context, Exception -> _)

  Adds an error handler for the given exception

• #add_filter_handler(handler : HTTP::Handler)
• #add_handler(handler : HTTP::Handler, position : Int32)
• #add_handler(handler : HTTP::Handler)
• #always_rescue : Bool
• #always_rescue=(always_rescue : Bool)
• #app_name : String
• #app_name=(app_name : String)
• #clear
• #env : String
• #env=(env : String)
• #error_handlers

  Returns the defined error handlers for HTTP status codes

• #exception_handlers

  Returns the defined error handlers for exceptions

• #extra_options : OptionParser -> Nil?
• #extra_options(&extra_options : OptionParser -> )
• #extra_options=(extra_options : Nil | OptionParser -> _)
• #handlers
• #handlers=(handlers : Array(HTTP::Handler))
• #host_binding : String
• #host_binding=(host_binding : String)
• #logger

  DEPRECATED Use standard library Log

• #logger=(logger : Kemal::BaseLogHandler)

  DEPRECATED Use standard library Log

• #logging : Bool
• #logging=(logging : Bool)
• #max_multipart_form_field_size : Int32
• #max_multipart_form_field_size=(max_multipart_form_field_size : Int32)
• #max_request_body_size : Int32
• #max_request_body_size=(max_request_body_size : Int32)
• #max_route_cache_size : Int32
• #max_route_cache_size=(max_route_cache_size : Int32)
• #port : Int32
• #port=(port : Int32)
• #powered_by_header=(powered_by_header : Bool)
• #powered_by_header? : Bool
• #public_folder : String
• #public_folder=(public_folder : String)
• #running : Bool
• #running=(running : Bool)
• #scheme
• #serve_static : Bool | Hash(String, Bool)
• #serve_static=(serve_static : Bool | Hash(String, Bool))
• #server : HTTP::Server | Nil
• #server=(server : HTTP::Server | Nil)
• #setup
• #shutdown_message : Bool
• #shutdown_message=(shutdown_message : Bool)
• #shutdown_timeout : Time::Span
• #shutdown_timeout=(shutdown_timeout : Time::Span)
• #ssl : OpenSSL::SSL::Context::Server?
• #ssl=(ssl : Nil | OpenSSL::SSL::Context::Server)
• #static_headers : HTTP::Server::Context, String, File::Info -> | Nil
• #static_headers=(static_headers : HTTP::Server::Context, String, File::Info -> | Nil)
• #websocket_allowed_origins : Array(String)

  When non-empty, WebSocket upgrade requests must send an Origin header that matches one of these values (after normalization: scheme/host/port only).

• #websocket_allowed_origins=(websocket_allowed_origins : Array(String))

  When non-empty, WebSocket upgrade requests must send an Origin header that matches one of these values (after normalization: scheme/host/port only).

Constructor Detail

Instance Method Detail