# Bref

> Bref is an open-source framework to run PHP applications on AWS Lambda (serverless): PHP runtimes for Lambda, deployment tooling, and integrations for Laravel and Symfony. Bref Cloud is the hosted service that deploys, monitors and operates Bref applications in your own AWS account.

Every documentation page is available as Markdown: append `.md` to its URL (for example https://bref.sh/docs/laravel/getting-started.md), or request the HTML URL with an `Accept: text/markdown` header. The whole documentation is also available as a single file: https://bref.sh/llms-full.txt

Bref is free and open-source (MIT license). Bref Cloud has a free plan for personal projects and paid plans with a free trial: https://bref.sh/cloud#pricing

## Documentation

- [What is Bref and serverless?](https://bref.sh/docs.md): An introduction to what serverless and Bref can offer for PHP applications.

## Documentation: Getting started

- [Setup](https://bref.sh/docs/setup.md): Getting ready to use Bref.
- [Laravel - Getting started](https://bref.sh/docs/laravel/getting-started.md): Run Laravel serverless on AWS Lambda using Bref.
- [Laravel - Environments](https://bref.sh/docs/laravel/environments.md): Configure Laravel environments and deployment environments with Bref.
- [Laravel - File storage](https://bref.sh/docs/laravel/file-storage.md)
- [Laravel - Laravel Queues](https://bref.sh/docs/laravel/queues.md): Run Laravel Queues on AWS Lambda and SQS using Bref.
- [Laravel - Laravel Octane](https://bref.sh/docs/laravel/octane.md): Run Laravel with Octane on AWS Lambda using Bref.
- [Laravel - Laravel Passport](https://bref.sh/docs/laravel/passport.md): Laravel Passport on AWS Lambda with Bref
- [Laravel - Caching](https://bref.sh/docs/laravel/caching.md)
- [Laravel - Maintenance mode](https://bref.sh/docs/laravel/maintenance-mode.md)
- [Symfony - Getting started](https://bref.sh/docs/symfony/getting-started.md): Run Symfony serverless on AWS Lambda using Bref.
- [Symfony - Symfony Messenger](https://bref.sh/docs/symfony/messenger.md): Run Symfony Messenger on AWS Lambda with SQS using Bref.
- [Symfony - Caching](https://bref.sh/docs/symfony/caching.md)
- [Symfony - Keeping the Kernel alive](https://bref.sh/docs/symfony/keep-alive.md)
- [Other frameworks - Getting started](https://bref.sh/docs/default/getting-started.md): Run PHP serverless on AWS Lambda using Bref.
- [Other frameworks - CLI commands](https://bref.sh/docs/default/cli-commands.md)

## Documentation: How it works

- [PHP runtimes for Lambda](https://bref.sh/docs/runtimes.md): PHP runtimes for PHP on AWS Lambda, provided by the Bref open-source project.
- [PHP runtimes for Lambda - PHP-FPM runtime](https://bref.sh/docs/runtimes/fpm-runtime.md): Learn how to run serverless HTTP applications with PHP on AWS Lambda using Bref.
- [PHP runtimes for Lambda - Function runtime](https://bref.sh/docs/runtimes/function.md): Run serverless event-driven PHP functions on AWS Lambda using Bref.
- [PHP runtimes for Lambda - Console runtime](https://bref.sh/docs/runtimes/console.md): Learn how to run serverless console commands on AWS Lambda with Symfony Console or Laravel Artisan.
- [PHP runtimes for Lambda - Runtimes in detail](https://bref.sh/docs/runtimes/runtimes-details.md)
- [How Bref works in details](https://bref.sh/docs/how-it-works.md): Deep dive into how PHP runs serverless on AWS Lambda with Bref
- [Serverless costs](https://bref.sh/docs/serverless-costs.md): Calculate the costs of running your PHP application on AWS Lambda.
- [Vendor lock-in](https://bref.sh/docs/vendor-lock-in.md): Is there vendor lock-in from using Bref and AWS Lambda?

## Documentation: Workflow

- [Deployment](https://bref.sh/docs/deploy.md)
- [Deployment - Deploying Docker images](https://bref.sh/docs/deploy/docker.md)
- [Deployment - Deploying with AWS CDK](https://bref.sh/docs/deploy/aws-cdk.md)
- [Local development](https://bref.sh/docs/local-development.md)
- [Local development - Event-driven functions](https://bref.sh/docs/local-development/event-driven-functions.md)
- [Monitoring](https://bref.sh/docs/monitoring.md)

## Documentation: Learn more

- [Use cases - HTTP applications](https://bref.sh/docs/use-cases/http.md)
- [HTTP applications - Custom domains](https://bref.sh/docs/use-cases/http/custom-domains.md): Configure custom domain names for your web applications.
- [HTTP applications - Binary requests and responses](https://bref.sh/docs/use-cases/http/binary-requests-responses.md)
- [HTTP applications - Advanced HTTP use cases](https://bref.sh/docs/use-cases/http/advanced-use-cases.md)
- [Use cases - Websites](https://bref.sh/docs/use-cases/websites.md): Learn how to deal with assets and static files to deploy serverless PHP websites.
- [Use cases - Static websites](https://bref.sh/docs/use-cases/static-websites.md)
- [Use cases - Cron tasks](https://bref.sh/docs/use-cases/cron.md): Learn how to create serverless cron functions with PHP on AWS Lambda.
- [Use cases - S3 file processing](https://bref.sh/docs/use-cases/s3.md)
- [Use cases - SQS asynchronous tasks](https://bref.sh/docs/use-cases/sqs.md)
- [Use cases - EventBridge event bus](https://bref.sh/docs/use-cases/eventbridge.md)
- [Use cases - WebSockets](https://bref.sh/docs/use-cases/websockets.md)
- [Use cases - SNS events](https://bref.sh/docs/use-cases/sns.md)
- [Use cases - DynamoDB events](https://bref.sh/docs/use-cases/dynamodb.md)
- [Use cases - Kinesis stream processing](https://bref.sh/docs/use-cases/kinesis.md)
- [Use cases - Kafka events](https://bref.sh/docs/use-cases/kafka.md)
- [Use cases - Custom architecture](https://bref.sh/docs/use-cases/custom-architecture.md)
- [Environment - serverless.yml](https://bref.sh/docs/environment/serverless-yml.md): Configure your application with the serverless.yml file.
- [Environment - Environment variables](https://bref.sh/docs/environment/variables.md): Define environment variables for your Bref application.
- [Environment - PHP](https://bref.sh/docs/environment/php.md): Configure PHP versions, extensions and options for your serverless application using Bref.
- [Environment - Storage](https://bref.sh/docs/environment/storage.md): Learn how to store data and files in serverless PHP applications running on AWS Lambda.
- [Environment - Logs](https://bref.sh/docs/environment/logs.md): Learn how to write and read PHP logs on AWS Lambda using Bref.
- [Environment - Databases](https://bref.sh/docs/environment/database.md): Configure Bref to use a database in your PHP application on AWS Lambda.
- [Environment - Databases - PlanetScale](https://bref.sh/docs/environment/database-planetscale.md): Configure Bref to use a PlanetScale database in your PHP application on AWS Lambda.
- [Environment - AWS credentials](https://bref.sh/docs/environment/aws-credentials.md): Access other AWS services from AWS Lambda by using the built-in AWS credentials.
- [Environment - Cold starts](https://bref.sh/docs/environment/cold-starts.md): Understanding and mitigating cold starts in serverless PHP applications on AWS Lambda with Bref.
- [Environment - Performance](https://bref.sh/docs/environment/performances.md): Performance tuning and optimizations for serverless PHP applications on AWS Lambda.
- [Community](https://bref.sh/docs/community.md): A collection of links to places where to discuss and learn about Bref.
- [Case studies](https://bref.sh/docs/case-studies.md): A collection of case studies of serverless PHP applications built using Bref. Learn about performance, costs and migrations from existing projects.
- [Case studies - How Craft CMS built Craft Cloud](https://bref.sh/docs/case-studies/craft-cloud.md): Craft Cloud is built on AWS and Cloudflare and uses Bref to run Craft CMS (and PHP) at scale on AWS Lambda
- [Case studies - Treezor: a serverless banking platform](https://bref.sh/docs/case-studies/treezor.md): Treezor migrated a legacy PHP application from servers to serverless on AWS Lambda. They gained increased scalability, faster response times and fewer production incidents.
- [Upgrading - From 1.x to 2.0](https://bref.sh/docs/upgrading/v2.md): Upgrading guide to go from Bref 1.x to Bref 2.0.
- [Upgrading - From 2.x to 3.0](https://bref.sh/docs/upgrading/v3.md): Upgrading guide to go from Bref 2.x to Bref 3.0.

## Documentation: Bref Cloud

- [Introduction](https://bref.sh/docs/cloud.md): Bref Cloud documentation.
- [Getting started](https://bref.sh/docs/cloud-getting-started.md): Installing the Bref CLI.
- [Deployment](https://bref.sh/docs/cloud-deploy.md): How to deploy Bref applications using Bref Cloud.
- [Security](https://bref.sh/docs/cloud-security.md): How Bref Cloud securely accesses your AWS accounts.

## Bref Cloud

- [Bref Cloud](https://bref.sh/cloud): Serverless PHP hosting on AWS Lambda: deploy, monitor and operate PHP applications in your own AWS account. Features, how it works, plans and pricing.
- [Bref Cloud documentation](https://bref.sh/docs/cloud.md): What Bref Cloud does and how to get started.

## Support and community

- [Support plans](https://bref.sh/support): Consulting and support plans for serverless migrations to AWS with Bref and PHP.
- [Community](https://bref.sh/docs/community.md): Slack, GitHub and other places to get help.
- [GitHub repository](https://github.com/brefphp/bref): source code, issues and releases of the open-source project.

## News

- [osls v4, and zero-downtime assets](https://bref.sh/news/04-august-2026.md): osls v4, zero-downtime deploys for website assets, and the latest Bref and Bref Cloud updates.
- [Bref 3.0 is released 🎉](https://bref.sh/news/03-bref-3.0.md): Bref 3.0 is released and reaches 40 billion invocations every month.
- [Bref 2.0 is released 🎉](https://bref.sh/news/02-bref-2.0.md): Bref 2.0 is released and reaches 10 billion invocations every month.
- [Bref 1.0 is released 🎉](https://bref.sh/news/01-bref-1.0.md): Bref 1.0 is released and reaches 1 billion invocations every month.

## Optional

- [Full documentation in one file](https://bref.sh/llms-full.txt)
- [Sitemap](https://bref.sh/sitemap.xml)