Laravel Vapor

https://docs.vapor.build
Admin
Laravel Vapor is an auto-scaling, serverless deployment platform for Laravel, powered by AWS Lambda,...
Tokens:22,879
Snippets:349
Trust Score:8.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### Get Help for a Vapor CLI Command

Source: https://docs.vapor.build/introduction

To learn more about a specific Vapor CLI command and its arguments, use the 'help' command followed by the command name. This example shows how to get help for the 'deploy' command.

```bash
php vendor/bin/vapor help deploy
```

--------------------------------

### Execute Vapor CLI Commands (Per-Project)

Source: https://docs.vapor.build/introduction

When the Vapor CLI is installed per project, execute commands using the vendor/bin directory. This example shows how to list all available commands.

```bash
php vendor/bin/vapor list
```

--------------------------------

### Example vapor.yml with a New Environment

Source: https://docs.vapor.build/projects/environments

This YAML snippet shows how a new environment entry is added to the `vapor.yml` file after creation.

```yaml
id: 2
name: vapor-laravel-app
environments:
    production:
        build:
            - 'composer install --no-dev'
    my-environment:
        build:
            - 'composer install --no-dev'
```

--------------------------------

### Initiate Deployment to Production

Source: https://docs.vapor.build/projects/deployments

Use this command to start a deployment to your production environment. Vapor will automatically look for a `vapor.yml` manifest file.

```bash
vapor deploy production
```

--------------------------------

### Example openssl.cnf Configuration

Source: https://docs.vapor.build/projects/development

This is an example 'openssl.cnf' file demonstrating CA, policy, and request configurations. It includes settings for serial numbers, databases, certificates, and key generation.

```ini
dir = certificates

[ ca ]
default_ca = CA_default

[ CA_default ]
serial = $dir/serial
database = $dir/index.txt
new_certs_dir = $dir/newcerts
certificate  = $dir/cacert.pem
private_key = $dir/private/cakey.pem
default_days = 36500
default_md  = sha256
preserve = no
email_in_dn  = no
nameopt = default_ca
certopt = default_ca
policy = policy_match

[ policy_match ]
commonName = supplied
countryName = optional
stateOrProvinceName = optional
organizationName = optional
organizationalUnitName = optional
emailAddress = optional

[ req ]
default_bits = 2048
default_keyfile = priv.pem
default_md = sha256
distinguished_name = req_distinguished_name
req_extensions = v3_req
encyrpt_key = no

[ req_distinguished_name ]

[ v3_ca ]
basicConstraints = CA:TRUE
subjectKeyIdentifier = hash
authorityKeyIdentifier = keyid:always,issuer:always

[ v3_req ]
basicConstraints = CA:FALSE
subjectKeyIdentifier = hash

```

--------------------------------

### Install Vapor CLI Globally or Per-Project

Source: https://docs.vapor.build/introduction

Install the Vapor CLI using Composer. You can install it globally for system-wide access or per-project for specific applications.

```bash
composer require laravel/vapor-cli --update-with-dependencies

composer global require laravel/vapor-cli --update-with-dependencies
```

--------------------------------

### Setup QEMU for ARM64 Emulation

Source: https://docs.vapor.build/projects/deployments

Add this step to your GitHub Actions workflow to set up QEMU for emulating the ARM64 architecture, necessary for compiling docker-arm based images.

```yml
- name: Setup QEMU
  uses: docker/setup-qemu-action@v2
  with:
    platforms: arm64
```

--------------------------------

### Adding Dependencies to Docker Image

Source: https://docs.vapor.build/projects/environments

Example Dockerfile showing how to add the ffmpeg library, mysql client, and gmp PHP extension.

```docker
FROM laravelphp/vapor:php85

# Add the `ffmpeg` library...
RUN apk --update add ffmpeg

# Add the `mysql` client...
RUN apk --update add mysql-client

# Add the `gmp` PHP extension...
RUN apk --update add gmp gmp-dev
RUN docker-php-ext-install gmp

# Place application in Lambda application directory...
COPY . /var/task
```

--------------------------------

### Dockerfile with Versioned Base Image

Source: https://docs.vapor.build/projects/environments

A Dockerfile example using an ARG instruction to dynamically set the base image version.

```docker
ARG VERSION=php85

FROM laravelphp/vapor:${VERSION}

COPY . /var/task
```

--------------------------------

### Configure Prewarming

Source: https://docs.vapor.build/projects/environments

Define the number of serverless containers to pre-warm in your `vapor.yml` file to mitigate cold starts after deployments.

```yaml
id: 2
name: vapor-laravel-app
environments:
    production:
        warm: 10
        build:
            - 'composer install --no-dev'
```

--------------------------------

### Install Vapor NPM Package

Source: https://docs.vapor.build/projects/deployments

Install the laravel-vapor NPM package as a dev dependency to use the Vapor.asset helper in JavaScript.

```bash
npm install --save-dev laravel-vapor

```

--------------------------------

### Install Vapor Core Package

Source: https://docs.vapor.build/introduction

Install the 'laravel/vapor-core' package as a dependency for your Laravel application. This package includes necessary runtime files and a service provider for Vapor.

```bash
composer require laravel/vapor-core --update-with-dependencies
```

--------------------------------

### Setting Docker Build Arguments via CLI

Source: https://docs.vapor.build/projects/environments

Example of using the Vapor CLI to specify Docker build arguments during deployment.

```bash
vapor deploy --build-arg VERSION=php74 --build-arg KEY=value
```

--------------------------------

### Execute Artisan Command

Source: https://docs.vapor.build/projects/environments

Run arbitrary Artisan commands against a Vapor environment. The first example shows a basic execution, while the second specifies a command directly.

```bash
vapor command production

vapor command production --command="php artisan inspire"
```

--------------------------------

### Configure OpenSSL with Environment Variable

Source: https://docs.vapor.build/projects/development

To use OpenSSL functions, create an 'openssl.cnf' file and set the 'OPENSSL_CONF' environment variable to its path. This example points to a file in the project root.

```ini
OPENSSL_CONF="/var/task/openssl.cnf"
```

--------------------------------

### Install laravel-vapor NPM Package

Source: https://docs.vapor.build/resources/storage

Install the laravel-vapor NPM package as a development dependency to facilitate direct file uploads to S3 from your frontend.

```bash
npm install --save-dev laravel-vapor
```

--------------------------------

### GitHub Actions Deployment Workflow

Source: https://docs.vapor.build/projects/deployments

Example GitHub Actions workflow file to automate Vapor deployments on push to the master branch. Requires VAPOR_API_TOKEN secret.

```yaml
name: Deploy

on:
  push:
    branches: [ master ]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Setup PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: 8.5
          tools: composer:v2
          coverage: none
      - name: Require Vapor CLI
        run: composer global require laravel/vapor-cli
      - name: Install Project Dependencies
        run: composer install --no-interaction --prefer-dist --optimize-autoloader
      - name: Deploy Environment
        run: vapor deploy production --commit="${{ github.sha }}" --message="${{ github.event.head_commit.message }}"
        env:
          VAPOR_API_TOKEN: ${{ secrets.VAPOR_API_TOKEN }}
```

--------------------------------

### Chipper CI Deployment Script

Source: https://docs.vapor.build/projects/deployments

This script, to be added as a step in Chipper CI's build pipeline, handles dependency installation and deploys the Vapor application when a commit is pushed to the master branch.

```bash
if [[ $CI_COMMIT_BRANCH == 'master' ]]; then
    composer install --no-interaction --prefer-dist --optimize-autoloader

    composer global require laravel/vapor-cli

    vapor deploy
fi
```

--------------------------------

### Get Deployment Hook Logs

Source: https://docs.vapor.build/projects/deployments

Access the detailed logs associated with a failing deployment hook by providing its ID.

```bash
vapor hook:log {DEPLOYMENT_HOOK_ID}
```

--------------------------------

### Get Deployment Hook Output

Source: https://docs.vapor.build/projects/deployments

Retrieve the output logs for a specific deployment hook using its ID.

```bash
vapor hook:output {DEPLOYMENT_HOOK_ID}
```

--------------------------------

### Configure Vapor Firewall in vapor.yml

Source: https://docs.vapor.build/projects/environments

Define the `firewall` configuration option in your `vapor.yml` file to enable Vapor's managed firewall. This example shows how to set a rate limit and enable bot control.

```yaml
id: 2
name: vapor-laravel-app
environments:
    production:
        build:
            - 'composer install --no-dev]'
        firewall:
            rate-limit: 1000
            bot-control:
                - CategorySearchEngine
                - CategorySocialMedia
                - CategoryScrapingFramework
```

--------------------------------

### Configure Native PHP Runtime in vapor.yml

Source: https://docs.vapor.build/projects/environments

Specify a native PHP runtime for your environment in the vapor.yml file. This example uses PHP 8.5 on Amazon Linux 2023.

```yaml
id: 2
name: vapor-laravel-app
environments:
    production:
        runtime: 'php-8.5:al2023'
        build:
            - 'composer install --no-dev'
```

--------------------------------

### Customize php.ini Directives

Source: https://docs.vapor.build/projects/environments

Customize core php.ini directives by creating a php.ini file in the php/conf.d directory. This example sets the upload_max_filesize to 4M.

```ini
upload_max_filesize = 4M
```

--------------------------------

### Dispatch Job After Response (Not Recommended on Vapor)

Source: https://docs.vapor.build/projects/development

This example shows dispatching a job to run after the HTTP response is sent. Vapor recommends dispatching jobs to queue workers instead, as it cannot execute jobs after sending a response.

```php
Route::get('/', function () {
    dispatch(function () {
        Mail::to('taylor@example.com')->send(new WelcomeMessage);
    })->afterResponse();

    return view('home');
});
```

--------------------------------

### CI Environment Variables for Asset Compilation

Source: https://docs.vapor.build/projects/deployments

Inject environment variables into your CI pipeline for asset compilation, using GitHub Actions as an example.

```yaml
- name: Deploy Environment
    run: vapor deploy production
    env:
      VITE_PUSHER_APP_KEY: ${{ secrets.VITE_PUSHER_APP_KEY }}

```

--------------------------------

### Initiate Deployment with Custom Manifest

Source: https://docs.vapor.build/projects/deployments

Specify a custom manifest file when initiating a deployment using the `--manifest` option.

```bash
vapor deploy production --manifest vapor-eu-west-1.yml
```

--------------------------------

### Create a Development Database

Source: https://docs.vapor.build/resources/databases

Use the `--dev` flag to quickly create a publicly accessible database of the smallest performance class, suitable for testing or staging.

```bash
vapor database my-test-database --dev
```

--------------------------------

### Create a Database

Source: https://docs.vapor.build/resources/databases

Use the `database` CLI command to create a new database. The command will prompt for further details.

```bash
vapor database my-application-db
```

--------------------------------

### Scale Fixed Size Database with CLI

Source: https://docs.vapor.build/resources/databases

Initiate scaling for a fixed size database using the `database:scale` command. Place the application in maintenance mode before scaling.

```bash
vapor database:scale my-application-db
```

--------------------------------

### Create a Docker Environment

Source: https://docs.vapor.build/projects/environments

Create a new environment that uses a Docker image runtime by adding the `--docker` option to the `env` command.

```bash
vapor env my-environment --docker
```

--------------------------------

### Open an Environment in Browser

Source: https://docs.vapor.build/projects/environments

Use the `open` command to quickly open a specific environment in your default web browser.

```bash
vapor open my-environment
```

--------------------------------

### Create Database User with CLI

Source: https://docs.vapor.build/resources/databases

Use the `database:user` CLI command to create a new database user. Vapor assigns a secure, random password.

```bash
vapor database:user my-application-db user-2
```

--------------------------------

### Initialize a New Vapor Project

Source: https://docs.vapor.build/projects/the-basics

Use the `vapor init` command within your Laravel project's root directory to initialize it for deployment with Laravel Vapor. This command generates the `vapor.yml` configuration file.

```bash
vapor init
```

--------------------------------

### Create a Jumpbox

Source: https://docs.vapor.build/resources/networks

Create a jumpbox server within your private network using the `jump` CLI command. This allows SSH access to resources that are not publicly accessible.

```bash
vapor jump my-jumpbox
```

--------------------------------

### Conditional Asset Helpers for Local vs. Vapor Deployments

Source: https://docs.vapor.build/projects/deployments

Use the `mix` helper for local development and the `asset` helper for Vapor deployments to correctly link assets when using hot module replacement and code splitting.

```php
@if (app()->environment('local'))
    <link href="{{ mix('css/admin/app.css') }}" rel="stylesheet">
    <script src="{{ mix('js/admin/app.js') }}"></script>
@else
    <link href="{{ asset('css/admin/app.css') }}" rel="stylesheet">
    <script src="{{ asset('js/admin/app.js') }}" defer></script>
@endif
```

--------------------------------

### Configure Existing Database Environment Variables

Source: https://docs.vapor.build/resources/databases

Set these environment variables to connect to an existing database. Ensure the Vapor project and database are in the same region or VPC.

```bash
DB_HOST=
DB_PORT=
DB_DATABASE=
DB_USERNAME=
DB_PASSWORD=
```

--------------------------------

### Create a New Environment

Source: https://docs.vapor.build/projects/environments

Use the `env` command to create a new environment for your project. This adds an entry to your `vapor.yml` file.

```bash
vapor env my-environment
```

--------------------------------

### Open Default and Specific Environments

Source: https://docs.vapor.build/projects/environments

The `open` command defaults to the 'staging' environment. You can specify other environments like 'production' to open them directly.

```bash
vapor open // Opens the `staging` environment in your default browser...

vapor open production // Opens the `production` environment in your default browser...
```

--------------------------------

### Create Load Balancer CLI

Source: https://docs.vapor.build/resources/networks

Use the `balancer` CLI command to create a new load balancer. Provide a name for your load balancer.

```bash
vapor balancer my-balancer
```

--------------------------------

### Access Private Database via Shell

Source: https://docs.vapor.build/resources/databases

After provisioning a jumpbox, use the `database:shell` command to access a command-line database shell for interacting with your private database.

```bash
vapor database:shell my-application-db
```

--------------------------------

### Vapor YAML Configuration with Build and Deploy Hooks

Source: https://docs.vapor.build/projects/deployments

Define build and deploy hooks within the `vapor.yml` file to automate preparation and migration tasks during deployment.

```yaml
id: 3
name: vapor-app
environments:
  production:
    memory: 1024
    database: vapor-app
    cache: vapor-cache
    build:
      - 'composer install --no-dev'
      - 'php artisan event:cache'
    deploy:
      - 'php artisan migrate --force'
```

--------------------------------

### View Database Metrics

Source: https://docs.vapor.build/resources/databases

Use the `database:metrics` command to view performance metrics for a specific database. You can specify a time range for the metrics.

```bash
vapor database:metrics my-application-db
```

```bash
vapor database:metrics my-application-db 5m
```

```bash
vapor database:metrics my-application-db 30m
```

```bash
vapor database:metrics my-application-db 1h
```

```bash
vapor database:metrics my-application-db 8h
```

```bash
vapor database:metrics my-application-db 1d
```

```bash
vapor database:metrics my-application-db 3d
```

```bash
vapor database:metrics my-application-db 7d
```

```bash
vapor database:metrics my-application-db 1M
```

--------------------------------

### Restore Database with CLI

Source: https://docs.vapor.build/resources/databases

Restore a database to a previous state using the `database:restore` command. This creates a new database with the specified name.

```bash
vapor database:restore current-database-name new-database-name
```

--------------------------------

### Upgrade Database with CLI

Source: https://docs.vapor.build/resources/databases

Upgrade a Vapor-managed MySQL database to a new version using the `database:upgrade` command. The original database remains unaffected.

```bash
vapor database:upgrade current-database-name new-database-name
```

--------------------------------

### Log In to Vapor CLI

Source: https://docs.vapor.build/introduction

Authenticate your Vapor CLI with your Vapor account using the 'login' command. This is necessary before you can manage your projects.

```bash
vapor login
```

--------------------------------

### View Environment Metrics

Source: https://docs.vapor.build/projects/environments

Access environment performance metrics using the 'metrics' CLI command with the environment name and optional timeframes.

```bash
vapor metrics production
```

```bash
vapor metrics production 5m
```

```bash
vapor metrics production 30m
```

```bash
vapor metrics production 1h
```

```bash
vapor metrics production 8h
```

```bash
vapor metrics production 1d
```

```bash
vapor metrics production 3d
```

```bash
vapor metrics production 7d
```

```bash
vapor metrics production 1M
```

--------------------------------

### Create a Cache with Vapor CLI

Source: https://docs.vapor.build/resources/caches

Use the `vapor cache` command to create a new cache. The CLI will prompt for details like the cache name and performance class.

```bash
vapor cache my-application-cache
```

--------------------------------

### Request an SSL Certificate

Source: https://docs.vapor.build/projects/domains

Generate a free, auto-renewing SSL certificate for your domain using the `cert` CLI command. This is required before attaching a domain to an environment.

```bash
vapor cert example.com
```

--------------------------------

### Attach Database to Environment

Source: https://docs.vapor.build/resources/databases

Configure your `vapor.yml` file to attach a database to a specific environment. Vapor automatically injects connection variables.

```yaml
id: 3
name: vapor-app
environments:
    production:
        database: my-application-db
        build:
            - 'composer install --no-dev'
        deploy:
            - 'php artisan migrate --force'
```

--------------------------------

### Attach Wildcard Subdomain to Environment

Source: https://docs.vapor.build/projects/domains

Configure a wildcard subdomain for your environment in `vapor.yml`. Requires a valid certificate for the primary domain.

```yaml
id: 2
name: vapor-laravel-app
environments:
    production:
        domain: '*.example.com'
        build:
            - 'composer install --no-dev'
```

--------------------------------

### Configure Environment to Use Load Balancer

Source: https://docs.vapor.build/resources/networks

To attach a load balancer to an environment, add a `balancer` key to the environment's configuration in `vapor.yml`. The value should be the name of the load balancer.

```yaml
id: 3
name: vapor-app
environments:
    production:
        balancer: my-balancer
        build:
            - 'composer install --no-dev'
```

--------------------------------

### Attach Multiple Domains to Environment

Source: https://docs.vapor.build/projects/domains

Configure multiple custom domains for your environment in `vapor.yml`. Ensure you have a valid SSL certificate for each domain.

```yaml
id: 2
name: vapor-laravel-app
environments:
    production:
        domain:
            - example1.com
            - example2.com
        build:
            - 'composer install --no-dev'
```

--------------------------------

### Return Binary Responses with Header

Source: https://docs.vapor.build/projects/development

To return binary responses like PDF downloads, include the 'X-Vapor-Base64-Encode' header set to 'True'. Note that Lambda limits responses to 6MB; for larger files, consider using a signed S3 URL.

```php
return $response->withHeaders([
    'X-Vapor-Base64-Encode' => 'True',
]);
```

--------------------------------

### Attach Multi-level Subdomain to Environment

Source: https://docs.vapor.build/projects/domains

Configure a multi-level subdomain for your environment in `vapor.yml`. The certificate must explicitly include the full subdomain.

```yaml
id: 2
name: vapor-laravel-app
environments:
    production:
        domain: 'v1.api.example.com'
        build:
            - 'composer install --no-dev'
```

--------------------------------

### Create User Policy for File Uploads

Source: https://docs.vapor.build/resources/storage

Generate a UserPolicy using Artisan and add an 'uploadFiles' method to authorize users for file uploads.

```bash
php artisan make:policy UserPolicy --model=User
```

--------------------------------

### Enable Dot Files as Assets in vapor.yml

Source: https://docs.vapor.build/projects/deployments

Set the `dot-files-as-assets` key to `true` in your `vapor.yml` file to ensure that dot files in the public directory are uploaded as assets.

```yaml
id: 1
name: app-test
dot-files-as-assets: true
```

--------------------------------

### List Projects for Current Team

Source: https://docs.vapor.build/projects/the-basics

View a list of projects associated with your currently active team using the `vapor project:list` command. This helps in managing multiple projects under a single team.

```bash
vapor project:list
```

--------------------------------

### Serve Asset Dot Files from Root Domain

Source: https://docs.vapor.build/projects/deployments

Include dot files in the `serve_assets` configuration array to serve them from the application's root domain.

```php
'serve_assets' => [
    'serviceWorker.js',
    '.well-known/assetlinks.json',
],
```

--------------------------------

### Create a DNS Record

Source: https://docs.vapor.build/projects/domains

Manage DNS records for a domain using the `record` CLI command. This command functions as an UPSERT operation, creating or updating records.

```bash
vapor record example.com A www 192.168.1.1
```

```bash
vapor record example.com A @ 192.168.1.1
```

```bash
vapor record example.com CNAME foo another-example.com
```

```bash
vapor record example.com MX foo "10 example.com,20 example2.com"
```

--------------------------------

### Configure Root Domain Assets in vapor.yml

Source: https://docs.vapor.build/projects/deployments

Define an array of assets to be served from your application's root domain instead of the S3 asset bucket or CloudFront CDN.

```php
/*
|--------------------------------------------------------------------------
| Servable Assets
|--------------------------------------------------------------------------
|
| Here you can configure list of public assets that should be servable
| from your application's domain instead of only being servable via
| the public S3 "asset" bucket or the AWS CloudFront CDN network.
|
*/

'serve_assets' => [
    'serviceWorker.js',
],
```

--------------------------------

### Enable Maintenance Mode with Secret

Source: https://docs.vapor.build/projects/environments

Places an environment into maintenance mode while allowing access via a custom secret path on the domain.

```bash
vapor down --secret="example-secret"
```

--------------------------------

### Retrieve Cache Metrics with Vapor CLI

Source: https://docs.vapor.build/resources/caches

Fetch performance metrics for a cache using the `cache:metrics` command. You can specify time ranges for the metrics.

```bash
vapor cache:metrics my-application-cache
```

```bash
vapor cache:metrics my-application-cache 5m
```

```bash
vapor cache:metrics my-application-cache 30m
```

```bash
vapor cache:metrics my-application-cache 1h
```

```bash
vapor cache:metrics my-application-cache 8h
```

```bash
vapor cache:metrics my-application-cache 1d
```

```bash
vapor cache:metrics my-application-cache 3d
```

```bash
vapor cache:metrics my-application-cache 7d
```

```bash
vapor cache:metrics my-application-cache 1M
```

--------------------------------

### List SSL Certificates

Source: https://docs.vapor.build/projects/domains

Check the validation status of SSL certificates for your domains with the `cert:list` CLI command.

```bash
vapor cert:list example.com
```

--------------------------------

### Add a Domain to Vapor

Source: https://docs.vapor.build/projects/domains

Use the `domain` CLI command to add a custom domain to your Vapor project. Always add the root domain.

```bash
vapor domain example.com
```

--------------------------------

### PlanetScale SSL CA Configuration

Source: https://docs.vapor.build/resources/databases

If your database is hosted by PlanetScale, use this path for the SSL certificate authority.

```bash
MYSQL_ATTR_SSL_CA=/opt/lib/curl/cert.pem
```

--------------------------------

### Attach Single Domain to Environment

Source: https://docs.vapor.build/projects/domains

Configure a single custom domain for your environment in `vapor.yml`. Vapor automatically handles SSL and routing.

```yaml
id: 2
name: vapor-laravel-app
environments:
    production:
        domain: example.com
        build:
            - 'composer install --no-dev'
```

--------------------------------

### Configure Docker Runtime in vapor.yml (x86)

Source: https://docs.vapor.build/projects/environments

Set the runtime to 'docker' in your vapor.yml file to use a custom Docker image for your environment on x86 architecture.

```yaml
# x86
id: 2
name: vapor-laravel-app
environments:
    production:
        runtime: docker
        build:
            - 'composer install --no-dev'
```

--------------------------------

### List Vapor Domains

Source: https://docs.vapor.build/projects/domains

View all domains associated with your Vapor project using the `domain:list` CLI command.

```bash
vapor domain:list
```

--------------------------------

### Use Vapor Asset Helper in JavaScript

Source: https://docs.vapor.build/projects/deployments

Generate URLs for public assets using the Vapor.asset helper in your JavaScript code.

```javascript
$('#container').prepend($('<img>', { src: Vapor.asset('avatar.png') }))

```

--------------------------------

### Base Dockerfile for Vapor

Source: https://docs.vapor.build/projects/environments

A basic Dockerfile for a Vapor environment using a PHP 8.5 base image. It copies the project files to the /var/task directory.

```docker
FROM laravelphp/vapor:php85

COPY . /var/task
```

--------------------------------

### Enable Maintenance Mode

Source: https://docs.vapor.build/projects/environments

Places a Vapor environment into maintenance mode. Access is restricted via custom domain but available via vanity URL.

```bash
vapor down production
```

--------------------------------

### Initialize Vapor JavaScript Object

Source: https://docs.vapor.build/projects/deployments

Initialize the global Vapor JavaScript object in your app.js file for both Vite and Mix.

```javascript
// Vite
import Vapor from 'laravel-vapor'
window.Vapor = Vapor

// Mix
window.Vapor = require('laravel-vapor');

```

--------------------------------

### Custom Dockerfile Configuration

Source: https://docs.vapor.build/projects/environments

Specifies a custom Dockerfile for a Docker runtime environment in vapor.yml.

```yaml
id: 2
name: vapor-laravel-app
environments:
    production:
        runtime: docker
        dockerfile: vapor.Dockerfile
        build:
            - 'composer install --no-dev'
```

--------------------------------

### Configure Environment to Use Specific Database User

Source: https://docs.vapor.build/resources/databases

Specify the database user in your `vapor.yml` file to connect to a database as that user.

```yaml
id: 3
name: vapor-app
environments:
    production:
        database: my-application-db
        database-user: user-2
        build:
            - 'composer install --no-dev'
        deploy:
            - 'php artisan migrate --force'
```

--------------------------------

### Configure Docker Build Options in vapor.yml

Source: https://docs.vapor.build/projects/deployments

Specify Docker build options, such as disabling provenance attestations, within the `vapor.yml` file for docker-arm runtimes to prevent deployment issues.

```yaml
id: 2
name: vapor-laravel-app
environments:
    production:
        runtime: docker-arm
        docker-build-options:
            - provenance=false
        build:
            - 'composer install --no-dev'
```

--------------------------------

### Set API Gateway v2 for Production Environment

Source: https://docs.vapor.build/projects/environments

Specifies the use of API Gateway v2 for a production environment in the vapor.yml file to potentially reduce request costs. Includes a sample build command.

```yaml
id: 2
name: vapor-laravel-app
environments:
    production:
        gateway-version: 2
        build:
            - 'composer install --no-dev'
```

--------------------------------

### Deploy from CI with Git Commit Info

Source: https://docs.vapor.build/projects/deployments

Pass Git commit and message information to the Vapor deploy command when deploying from a CI platform like CodeShip.

```sh
vapor deploy production --commit="${CI_COMMIT_ID}" --message="${CI_MESSAGE}"
```

--------------------------------

### Copying Custom php.ini to Docker Image

Source: https://docs.vapor.build/projects/environments

Dockerfile snippet demonstrating how to copy a local php.ini file into the Docker image.

```docker
FROM laravelphp/vapor:php85

COPY ./php.ini /usr/local/etc/php/conf.d/overrides.ini

COPY . /var/task
```

--------------------------------

### Request Certificate for Multi-level Subdomain

Source: https://docs.vapor.build/projects/domains

Use the Vapor CLI to request an SSL certificate for a multi-level subdomain.

```shell
vapor cert v1.api.example.com
```

--------------------------------

### Re-run Previous Command

Source: https://docs.vapor.build/projects/environments

Use the `command:again` CLI command to re-execute the last run command or a specific command by its ID.

```bash
# Run the previous command again...
vapor command:again

# Run a specific command again using the command's ID...
vapor command:again 50
```

--------------------------------

### Dockerfile for Arm Architecture Docker Runtime

Source: https://docs.vapor.build/projects/environments

Use this Dockerfile to leverage Arm architecture for increased performance and cost savings in your Vapor Docker environment. It specifies a PHP 8.5 Arm base image.

```docker
FROM laravelphp/vapor:php85-arm

COPY . /var/task
```

--------------------------------

### Add Passport Keys to Encrypted Environment File

Source: https://docs.vapor.build/projects/environments

Appends local Passport keys to a specified environment's .env file. Ensure to re-encrypt and redeploy after use.

```bash
vapor env:passport production
```

--------------------------------

### Configure API Gateway v2 in vapor.yml

Source: https://docs.vapor.build/kb/troubleshooting

Specify `gateway-version: 2` in your `vapor.yml` file to use API Gateway v2. This can reduce request latency but may have regional implications and feature limitations.

```yaml
gateway-version: 2
```

--------------------------------

### Docker Build Arguments in vapor.yml

Source: https://docs.vapor.build/projects/environments

Configuration in vapor.yml to set Docker build arguments, such as the image version.

```yaml
id: 2
name: vapor-laravel-app
environments:
    production:
        runtime: docker
        docker-build-args:
            VERSION: php85
        build:
            - 'composer install --no-dev'
```

--------------------------------

### Configure Memory Allocation

Source: https://docs.vapor.build/projects/environments

Adjust the memory allocated to your Lambda function in the `vapor.yml` file. Memory is proportional to CPU power.

```yaml
id: 2
name: vapor-laravel-app
environments:
    production:
        memory: 1024
        build:
            - 'composer install --no-dev'
```

--------------------------------

### Push Environment Variables

Source: https://docs.vapor.build/projects/environments

Pushes the environment variables from the local `.env.{environment}` file back to Vapor. This command should be used after editing the pulled environment file.

```bash
vapor env:push production
```

--------------------------------

### Configure Custom VPC for Vapor Environment

Source: https://docs.vapor.build/projects/environments

Specify custom subnets and security groups for a Vapor environment in your `vapor.yml` file to place Lambda functions within a non-Vapor-managed VPC.

```yaml
id: 2
name: vapor-laravel-app
environments:
    production:
        subnets:
            - subnet-08aczain4man8bba7
            - subnet-08acr4nd0mbba7
        security-groups:
            - sg-0cr4and0m45b7e0
```

--------------------------------

### Enable Persistent Database Connections for Queues

Source: https://docs.vapor.build/resources/queues

Set `queue-database-session-persist` to `true` in `vapor.yml` to reuse the same database connection across queued jobs. This can reduce overhead if your database can handle many connections.

```yaml
id: 2
name: vapor-laravel-app
environments:
    production:
        queue-database-session-persist: true
        build:
            - 'composer install --no-dev'
```

--------------------------------

### Enable Sub-Minute Scheduler in Vapor

Source: https://docs.vapor.build/projects/environments

Enable Vapor's own scheduler engine for sub-minute tasks by setting 'scheduler: sub-minute'. Ensure 'cli-timeout' is >= 120 and 'cli-concurrency' is >= 2.

```yaml
id: 2
name: vapor-laravel-app
environments:
    production:
        scheduler: sub-minute
        cli-timeout: 120
```

--------------------------------

### Implement uploadFiles Method in UserPolicy

Source: https://docs.vapor.build/resources/storage

Implement the 'uploadFiles' method in your UserPolicy to return true if the authenticated user is allowed to upload files, and false otherwise.

```php
/**
 * Determine whether the user can upload files.
 *
 * @param  \App\User  $user
 * @return mixed
 */
public function uploadFiles(User $user)
{
    return true;
}
```

--------------------------------

### Initialize Vapor JavaScript Object

Source: https://docs.vapor.build/resources/storage

Initialize the global Vapor JavaScript object in your application's app.js file for both Vite and Mix build tools.

```javascript
// Vite
import Vapor from 'laravel-vapor'
window.Vapor = Vapor

// Mix
window.Vapor = require('laravel-vapor');
```

--------------------------------

### Disable robots.txt Redirection in config/vapor.php

Source: https://docs.vapor.build/projects/deployments

Set the `redirect_robots_txt` configuration value to `false` in `config/vapor.php` to serve the `robots.txt` file directly from your application.

```php
'redirect_robots_txt' => false,
```

--------------------------------

### Delete Database

Source: https://docs.vapor.build/resources/databases

Use the `database:delete` command to permanently remove a database. Exercise caution as deleted databases cannot be recovered.

```bash
vapor database:delete my-application-db
```

--------------------------------

### Enable Octane in Vapor Environment

Source: https://docs.vapor.build/projects/environments

Instructs Vapor to use Laravel Octane by setting the 'octane' configuration option to true within the application's vapor.yml file for a specific environment.

```yaml
id: 1
name: my-application
environments:
    staging:
        memory: 1024
        runtime: 'php-8.5:al2023'
        octane: true
```

--------------------------------

### Configure S3 Storage in vapor.yml

Source: https://docs.vapor.build/resources/storage

Add a 'storage' key to your environment's vapor.yml configuration to specify an S3 bucket name. Vapor will ensure the bucket exists during deployment.

```yaml
id: 3
name: vapor-app
environments:
    production:
        storage: my-bucket-name
        memory: 1024
        build:
            - 'composer install --no-dev'
        deploy:
            - 'php artisan migrate --force'
```

--------------------------------

### Configure Concurrency Limit

Source: https://docs.vapor.build/projects/environments

Set a custom maximum concurrency limit for your application in the `vapor.yml` file to manage request handling and prevent excessive costs.

```yaml
id: 2
name: vapor-laravel-app
environments:
    production:
        concurrency: 50
        build:
            - 'composer install --no-dev'
```
Tokens:
Raw