thoughtco / statamic-eyris
Installs: 17
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
pkg:composer/thoughtco/statamic-eyris
Requires
- php: ^8.2
- pixelfear/composer-dist-plugin: ^0.1.5
- statamic/cms: ^5.0 || ^6.0
Requires (Dev)
- laravel/pint: ^1.13
- mockery/mockery: ^1.3.1
- nunomaduro/collision: ^8.0
- orchestra/testbench: ^9.0
- pestphp/pest: ^2.24
- phpunit/phpunit: ^10.0
README
Statamic Eyris provides healthcheck information on your Statamic sites and synchronises your users across your sites.
How to Install
Run the following command from your project root:
composer require thoughtco/statamic-eyris
Sign up for an account at www.eyris.app, then add your Eyris account token to your .env file:
EYRIS_TOKEN="my-token"
You can also optionally publish the config:
php artisan vendor:publish --tag=statamic-eyris
How it works
Once installed Eyris will detect and create your site on the platform, assigning a unique Installation ID for the site.
Once every hour Eyris will update the current environment, including your Statamic version, your addon versions, and other metrics that will be useful for you to monitor. If you have the task scheduler enabled this will happen via the console, otherwise it will happen as part of a visitor's hit to your website.
Hooks
If you want to return extra data to Eyris, you can hook into the update environment payload:
\Thoughtco\Eyris\Facades\Agent::hook('update-environment-payload', function ($payload, $next) { // add to payload, this should be in the following format // eg [ ['label' => 'My label', 'value' => 'my_value'] ] return $next($payload); );
Widget
We provide an announcement widget to let you push announcements from the system to your site.
To enable it add eyris-announcements to config/statamic/cp.php under the 'widgets' key.
Note: this feature is only supported on Statamic v6+.