Config Reference

Here’s a list of the available config settings.

Name Default Description
api.api_key_required false Whether or not to require API key
api.authorization_type NONE API Gateway default authorization_type
api.authorizers.default_token_source Auth This the header to look for and use in the method.request.header. IE: method.request.header.Auth
api.auto_replace nil Whether or not to auto replace the API Gateway when necessary. By default, will prompt user. Setting this to true bypasses the prompt. Note changing the API Gateway will change the endpoint. It’s recommended to set up a custom domain which is updated with the new API Gateway endpoint automatically.
api.binary_media_types [‘multipart/form-data’] Content types to treat as binary
api.cors_authorization_type nil API Gateway default authorization_type for CORS. Note, default is nil so ApiGateway::Cors#cors_authorization_type handles.
api.endpoint_policy nil Note, required when endpoint_type is EDGE
api.endpoint_type EDGE Endpoint type. IE: PRIVATE, EDGE, REGIONAL
app.domain nil The app domain to use. Should be the domain only without the protocol. This applies at the controller-level, IE: methods like redirect_to
assets.base_url nil Base url to use to serve assets. IE: By default this is the s3 website url that jets manages.
assets.cache_control nil The cache control expiry. IE: public, max-age=3600. Note, assets.max_age is a shorter way to set cache_control.
assets.folders %w[assets images packs] Folders to assets package and upload to s3
assets.max_age 3600 Default max age on assets
assets.webpacker_asset_host s3_endpoint Default uses the s3 endpoint url. You can set an explicit value if you need to override. Also if assets.base_url is use, that will be used. Precedence: 1. assets.webpacker_asset_host 2. assets.base_host 3. s3_endpoint
autoload_paths [] Customize autoload paths. Add extra paths you want to Jets autoload.
controllers.default_protect_from_forgery true for html mode, false for api mode. Whether or not to check for forgery protection
controllers.filtered_parameters [] Parameters to filter in logging output
cors false Enable cors
deploy.stagger.batch_size 10 Stagger the cloudformation update batch size.
deploy.stagger.enabled false Stagger the cloudformation update. Can be helpful with large apps.
domain.cert_arn nil Cert ARN for SSL
domain.endpoint_type REGIONAL The endpoint type to create for API Gateway custom domain. IE: EDGE or REGIONAL. Default to EDGE because CloudFormation update is faster nil Custom domain name to use. Recommend to leave nil and jets will set a conventional custom domain name and then use CloudFront in front outside of Jets to fully control the domain name.
domain.route53 true Controls whether or not to create the managed route53 record.
encoding.default utf-8 Default encoding
function.ephemeral_storage.size 512 Lambda function default size of the /tmp directory in megabytes
function.memory_size 1536 Lambda function default memory size
function.timeout 30 Lambda function default timeout
gems.clean false Whether or not to always rebuild binary gems in the cache folder.
gems.disable false Disable use of Serverless Gems service. Note, this means you must build a custom lambda layer yourself.
gems.source Default serverlessgems source nil Override the host value use in the view helpers. IE:
hot_reload Defaults to true in development and false in other envs Whether or not to hot reload
ignore_paths [] Customize ignore paths. These paths will be ignored by the autoloader.
inflections.irregular {} Special case inflections
lambda.layers [] Additional custom lambda layers to use.
logger$stderr) Jets logger
prewarm.concurrency 2 Prewarning concurrency
prewarm.enable true Enable prewarming noop call.
prewarm.public_ratio 3 Prewarming public ratio
prewarm.rack_ratio 5 Prewarming rack ratio
prewarm.rate 30 minutes Prewarming Rate
project_name generated as part of jets new Jets project name
ruby.check true Check at bootup time for supported Ruby versions.
ruby.supported_versions %w[2.5 2.7 3.2] List of officially supported Ruby versions.
s3_event.configure_bucket true Whether or not to customer the bucket with the event notification trigger.
s3_event.notification_configuration nil Notification configuration
session.options {} Session storage options Rack::Session::Cookie Session storage. Note when accessing it use session[:store] since .store is an OrderedOptions method.
time_zone UTC Time zone

Here’s also the application/defaults.rb source where these config options are defined.