Installation

Statamic utilizes Composer to manage its dependencies. So, before using Statamic, make sure you have Composer installed on your machine.

Writing Stage: Ready for Feedback

Creating a new Statamic project?

If you want to start from scratch, use Composer to create a project based off the statamic/statamic starter site.

composer create-project statamic/statamic {change_me} --prefer-dist --stability=dev

(hint: replace {change_me} with whatever you’d like to name your site.)

Starter Kits

You can also use one of the starter kits to jump ahead with a pre-built site. Each starter kit has its own installation docs.

You can also install into an existing Laravel app

  1. Add the statamic:install command to post-autoload-dump in composer.json.

    "post-autoload-dump": [
        "Illuminate\\Foundation\\ComposerScripts::postAutoloadDump",
        "@php artisan package:discover --ansi",
        "@php artisan statamic:install --ansi"
    ],
    
  2. Require statamic/cms.

    composer require statamic/cms
    
  3. If you have existing users in your application, follow these instructions to learn how to make them compatible with Statamic, or how to switch to Statamic’s file-based user driver.

After Statamic is installed, you’ll have the content/, users/, and config/statamic directories added to your project. Your app will continue to work as before and you’ll have Statamic available at your fingertips.

Your explicit routes will take precedence and anything not caught by your app will run through Statamic and will work as documented. Enjoy!

Updating

From within your project, use Composer to update the Statamic CMS package:

composer update statamic/cms --with-dependencies

You may prefer to run composer update to update all of your dependencies listed in your composer.json file

Betterify this page on Github!