Configuration

Complete reference for Polyform configuration options

Everything in Polyform is configured through config/polyform.php. This page covers every available option.

Publishing Config

The config file is published automatically when you run php artisan polyform:init. To republish manually: php artisan vendor:publish --tag=polyform-config.

Table Prefix

Change the database table prefix if the default conflicts with your existing tables:

config/polyform.php

Key	Type	Default	Description
`table_prefix`	string	polyform_	Prefix for all Polyform database tables (forms, form_fields, etc.)

Model Classes

All models are referenced through config, so you can swap in your own subclasses whenever you need custom behavior:

config/polyform.php

Key	Default Class	Description
`form`	Polyform\Models\Form	Main form model
`form_field`	Polyform\Models\FormField	Individual field definition
`form_step`	Polyform\Models\FormStep	Multi-step form steps
`form_submission`	Polyform\Models\FormSubmission	Submitted form data
`form_submission_field`	Polyform\Models\FormSubmissionField	Individual submission field values
`form_field_option`	Polyform\Models\FormFieldOption	Static options for select/radio/checkbox fields
`form_webhook`	Polyform\Models\FormWebhook	Webhook configurations
`form_webhook_delivery`	Polyform\Models\FormWebhookDelivery	Webhook delivery logs
`form_export`	Polyform\Models\FormExport	Export job tracking

Extending Models

To customize a model, extend the base class and update the config:

config/polyform.php

File Storage

Controls where uploaded files go and what's allowed:

Key	Type	Default	Description
`files.disk`	string	public	Laravel filesystem disk for storing uploads
`files.path`	string	polyform-uploads	Directory path within the disk
`files.max_size_kb`	int	10240	Maximum file size in KB (default: 10MB)
`files.allowed_extensions`	array	jpg, png, pdf, docx, xlsx, etc.	Allowed file extensions (26 common types)

Key	Type	Default	Description
`file_storage_handler`	string	Polyform\Services\LocalFileStorageHandler	Class implementing FileStorageHandler interface

Custom Storage Handlers

For cloud storage (S3, DigitalOcean, etc.), create a handler that implements Polyform\Contracts\FileStorageHandler.

Submission Tracking

Choose what metadata gets stored with each submission:

Key	Type	Default	Description
`submissions.track_ip`	bool	true	Store submitter IP address
`submissions.track_user_agent`	bool	true	Store submitter browser user agent
`submissions.prune_after_days`	int\|null	null	Auto-delete submissions after N days (null = never)

Privacy Compliance

Set track_ip and track_user_agent to false for GDPR/CCPA compliance, or use prune_after_days to set up data retention.

Caching

Polyform caches form structures and submission counts to keep things fast:

Key	Type	Default	Description
`cache.enabled`	bool	true	Enable form structure caching
`cache.ttl`	int	3600	Cache TTL in seconds (default: 1 hour)
`cache.prefix`	string	polyform	Cache key prefix

Rich Text Editor

Settings for the rich text field (built on Tiptap):

Key	Type	Default	Description
`rich_text.allowed_extensions`	array	[Bold, Italic, Underline, Strike, Link, etc.]	Tiptap extensions to enable
`rich_text.max_length`	int\|null	null	Maximum character count (null = unlimited)

Rating Field Defaults

Defaults applied to rating fields:

Key	Type	Default	Description
`rating.max`	int	5	Default maximum rating value
`rating.icon`	string	star	Icon to display (star, heart, thumb)

Scale Field Defaults

Defaults for scale fields (e.g., a 1-10 slider):

Key	Type	Default	Description
`scale.min`	int	1	Default minimum value
`scale.max`	int	10	Default maximum value
`scale.step`	int	1	Default step increment

Multi-Step Forms

Controls how multi-step forms behave:

Key	Type	Default	Description
`steps.validate_on_next`	bool	true	Validate current step before advancing
`steps.show_progress`	bool	true	Display progress indicator
`steps.allow_back`	bool	true	Allow navigating to previous steps

Autosave

Automatic draft saving settings:

Key	Type	Default	Description
`autosave.enabled`	bool	false	Enable autosave for drafts
`autosave.interval`	int	30000	Autosave interval in milliseconds (default: 30s)

Webhooks

Webhook dispatching and security settings:

Key	Type	Default	Description
`webhooks.enabled`	bool	true	Enable webhook dispatching
`webhooks.queue`	string	default	Queue name for webhook jobs
`webhooks.timeout`	int	10	HTTP request timeout in seconds
`webhooks.max_retries`	int	3	Maximum retry attempts on failure
`webhooks.signing_secret`	string\|null	env(POLYFORM_WEBHOOK_SECRET)	Secret for HMAC signature verification
`webhooks.signature_header`	string	X-Polyform-Signature	HTTP header name for signature

Webhook Security

Always set a signing secret in production. Generate a random string and add it to your .env as POLYFORM_WEBHOOK_SECRET.

Data Exports

Settings for exporting submission data:

Key	Type	Default	Description
`exports.disk`	string	local	Filesystem disk for storing exports
`exports.path`	string	polyform-exports	Directory path within the disk
`exports.formats`	array	[csv, json, xlsx]	Supported export formats
`exports.chunk_size`	int	1000	Process submissions in chunks (memory optimization)
`exports.prune_after_days`	int	7	Auto-delete export files after N days

Option Sources

Enum Sources

Map PHP enums to option sources:

Key	Description
`option_sources.enums`	Array mapping source keys to enum class names (e.g., 'user_roles' => UserRole::class)

Model Sources

Load options from Eloquent models:

Key	Description
`option_sources.models`	Array mapping source keys to model class names (e.g., 'countries' => Country::class)

Custom Resolvers

Key	Description
`option_sources.resolvers`	Array mapping source keys to resolver class names implementing DynamicOptionResolver

Custom Option Sources

Option sources support search, pagination and dependencies between fields. See the Option Sources docs for implementation details.

Environment Variables

A few config values can be set directly via your .env file:

Variable	Config Key	Default
POLYFORM_TABLE_PREFIX	polyform.table_prefix	polyform_
POLYFORM_CACHE_ENABLED	polyform.cache.enabled	true
POLYFORM_WEBHOOK_SECRET	polyform.webhooks.signing_secret	null
POLYFORM_EXPORTS_DISK	polyform.exports.disk	local

Installation Quickstart