Skip to content

Commit 86f1840

Browse files
committed
Updated README
1 parent 9ef2ccd commit 86f1840

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,12 @@
1111

1212
This package allows you to use Google Cloud Scheduler to schedule Laravel commands.
1313

14+
It only supports Artisan commands at this time due to security concerns.
15+
1416
# How it works
1517

18+
Cloud Tasks will make a HTTP call to your application. This package adds an endpoint to your application that accepts the HTTP call and its payload (an Artisan command) and executes the command.
19+
1620
# Requirements
1721

1822
This package requires Laravel 5.6 or higher.
@@ -34,3 +38,18 @@ Please check the table below for supported Laravel and PHP versions:
3438
```bash
3539
composer require stackkit/laravel-google-cloud-scheduler
3640
```
41+
42+
# Cloud Scheduler Example
43+
44+
Here is an example job that will run `php artisan inspire` every minute.
45+
46+
These are the most important settings:
47+
- Target must be `HTTP`
48+
- URL must be `yourdomainname.com/cloud-scheduler-job`
49+
- Auth header must be OIDC token!
50+
51+
<img src="/example.png">
52+
53+
# Planned features
54+
55+
Laravel's console kernel allows to execute actions after the command has finished running (such as ping a service) and prevent overlapping. This package does not support those features at this time. The goal is to eventually read the configured settings for a command (as defined in the console kernel) and execute the command exacty as defined there so that methods like `thenPing` and `withoutOverlapping` work out of the box without the need to configure anything.

example.png

119 KB
Loading

0 commit comments

Comments
 (0)