Skip to main content
Version: 8.x

How to Deploy a Statamic Project

require 'recipe/statamic.php';

Source

Deployer is a free and open source deployment tool written in PHP. It helps you to deploy your Statamic application to a server. It is very easy to use and has a lot of features.

Three main features of Deployer are:

  • Provisioning - provision your server for you.
  • Zero downtime deployment - deploy your application without a downtime.
  • Rollbacks - rollback your application to a previous version, if something goes wrong.

Additionally, Deployer has a lot of other features, like:

  • Easy to use - Deployer is very easy to use. It has a simple and intuitive syntax.
  • Fast - Deployer is very fast. It uses parallel connections to deploy your application.
  • Secure - Deployer uses SSH to connect to your server.
  • Supports all major PHP frameworks - Deployer supports all major PHP frameworks.

You can read more about Deployer in Getting Started.

The deploy task of Statamic consists of:

The statamic recipe is based on the laravel recipe.

Configuration

statamic_version

Source

Default value
$result = run('{{bin/php}} {{release_or_current_path}}/please --version');
preg_match_all('/(\d+\.?)+/', $result, $matches);
return $matches[0][0] ?? 'unknown';

Tasks

statamic:addons:discover

Source

Rebuilds the cached addon package manifest.

Addons

statamic:assets:generate-presets

Source

Generates asset preset manipulations.

Assets

statamic:assets:meta

Source

Generates asset metadata files.

statamic:git:commit

Source

Git add and commit tracked content.

Git

statamic:glide:clear

Source

Clears the Glide image cache.

Glide

statamic:responsive:generate

Source

Generates responsive images.

Responsive Images (not in the core)

statamic:responsive:regenerate

Source

Regenerate responsive images.

statamic:search:insert

Source

Inserts an item into its search indexes.

Search

statamic:search:update

Source

Update a search index.

statamic:stache:clear

Source

Clears the "Stache" cache.

Stache

statamic:stache:doctor

Source

Diagnose any problems with the Stache.

statamic:stache:refresh

Source

Clears and rebuild the "Stache" cache.

statamic:stache:warm

Source

Builds the "Stache" cache.

statamic:static:clear

Source

Clears the static page cache.

Static

statamic:static:warm

Source

Warms the static cache by visiting all URLs.

statamic:support:details

Source

Outputs details helpful for support requests.

Support

statamic:updates:run

Source

Runs update scripts from specific version.

Updated

deploy

Source

Deploys your project.

Main Deploy Script for Statamic, which will overwrite the Laravel default.

This task is group task which contains next tasks: