https://github.com/tomhatzer/statamic-vapor-compatibility
A package to make Statamic deployable on Laravel Vapor
https://github.com/tomhatzer/statamic-vapor-compatibility
Last synced: 5 months ago
JSON representation
A package to make Statamic deployable on Laravel Vapor
- Host: GitHub
- URL: https://github.com/tomhatzer/statamic-vapor-compatibility
- Owner: tomhatzer
- License: mit
- Created: 2021-07-01T18:47:44.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-02T18:33:21.000Z (almost 5 years ago)
- Last Synced: 2025-10-11T14:07:12.566Z (9 months ago)
- Language: PHP
- Size: 16.6 KB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# A package to make Statamic deployable on Laravel Vapor
[](https://packagist.org/packages/tomhatzer/statamic-vapor-compatibility)
[](https://packagist.org/packages/tomhatzer/statamic-vapor-compatibility)
This package adds functionality to be able to run Statamic on Laravel Vapor using a container image.
## Installation
### Install the package via composer:
```bash
composer require tomhatzer/statamic-vapor-compatibility
```
### Publish the config file with:
```bash
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:
```bash
STATAMIC_FILES_REPOSITORY=https://@github.com//.git
STATAMIC_FILES_REPOSITORY_NAME=
STATAMIC_GIT_NAME=
STATAMIC_GIT_EMAIL=
```
### Execute the following command to update your Dockerfiles:
```bash
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](https://statamic.dev/extending/events), the [Listeners](src/Listeners) folder and the [events config item](config/statamic-vapor-compatibility.php#L42) of this package to see how it's done.
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Tom Hatzer](https://github.com/tomhatzer)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.