README

This package adds functionality to be able to run Statamic on Laravel Vapor using a container image.

Installation

Install the package via composer:

composer require tomhatzer/statamic-vapor-compatibility

Publish the config file with:

php artisan vendor:publish --provider="StatamicVaporCompatibility\StatamicVaporCompatibilityServiceProvider" --tag="statamic-vapor-compatibility-config"

Create a new personal access token on github for your account or organization

This is necessary to be able to pull and push from your private repository.

Add a new private repository to your github account.

Please be sure to use a private repository as all your files including user files will be stored in this repository.

Extend your stages environment variables on Laravel Vapor with the following variables:

STATAMIC_FILES_REPOSITORY=https://<personal-access-token-you-created-earlier>@github.com/<your-username-or-organization>/<name-of-private-repository-you-created-earlier>.git
STATAMIC_FILES_REPOSITORY_NAME=<name-of-the-folder-where-you-want-to-store-your-files>
STATAMIC_GIT_NAME=<your-git-user-name>
STATAMIC_GIT_EMAIL=<your-git-user-email>

Execute the following command to update your Dockerfiles:

php artisan statamic-vapor:check-dockerfile

Please check your Dockerfile manually afterwards to see if there are any incompatible changes.

Statamic addon compatibility

You can add Events and Listeners to your addon and ask your users to add them to our config file manually.

Please refer to the Events section in the Statamic docs, the Listeners folder and the events config item of this package to see how it's done.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

tomhatzer / statamic-vapor-compatibility

Maintainers

Details