Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ibexa/cron

ibexa-bundle

Last synced: 6 days ago
JSON representation

Host: GitHub
URL: https://github.com/ibexa/cron
Owner: ibexa
License: other
Created: 2021-03-31T07:25:00.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-04-11T13:52:54.000Z (7 months ago)
Last Synced: 2024-04-11T15:48:14.595Z (7 months ago)
Topics: ibexa-bundle
Language: PHP
Homepage:
Size: 91.8 KB
Stars: 2
Watchers: 12
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Ibexa Cron

This package exposes [cron/cron](https://github.com/Cron/Cron) package for use in Ibexa (or just plain Symfony) via a simle command
`ibexa:cron:run`.

This is *not* a replacement for [cron/cron-bundle](https://github.com/Cron/Symfony-Bundle) but rather a simpler alternative to it which can more easily grow into focusing more on Ibexa Platform needs in the future including e.g. support for handling cron jobs across a cluster install _(separating jobs that should run on all nodes vs jobs that should only be run on one at a time and a lock system to go with it for instance)_.

## Setup system cron

Pick your systems cron / scheduling and setup `ezplatform:cron:run` command to run every minute and optionally specifying category _(default: `default`)_:

Example for Linux crontab (`crontab -e`):
```bash
* * * * * /path/to/php app/console ezplatform:cron:run [ --category=default] >/dev/null 2>&1
```

## Setting up own cron commands

Setting up own cron jobs is as simple as tagging services for your existing Symfony Commands.

The tag takes the following arguments:
- `name`: `ibexa.cron.job`
- `schedule`: _Takes any kind of [format supported by cron/cron](https://github.com/Cron/Cron#crontab-syntax), which mimics linux crontab format. E.g. `* * * * *`_
- `category`: _(Optional, by default: `default`) Lets you separate cronjobs that should be run under different logic then default, e.g. infrequent jobs (NOTE: Means end user will need to setup several entries in his crontab to run all categories!)_
- `options`: _(Optional, by default: `''`) Takes custom option/s in string format which are added to the command. (E.g. '--keep=0 --status=draft' for running the cleanup versions command)_

### Example

```yml
date_based_published.cron.publish_scheduled:
class: EzSystems\DateBasedPublisherBundle\Command\PublishScheduledCommand
tags:
- { name: console.command }
- { name: ibexa.cron.job, schedule: '* * * * *' }
```

## Logging run command
If you want to log outputs of commands processed by run command you have to add the monolog channel `cronjob` to your configuration.

### Example
```yml
monolog:
channels: [...,'cronjob']
handlers:
cronjob:
bubble: false
level: info
type: stream
path: '%kernel.logs_dir%/cronjob.log'
channels: [cronjob]
```

## LICENSE
This source code is available separately under the following licenses:

A - Ibexa Business Use License Agreement (Ibexa BUL),
version 2.4 or later versions (as license terms may be updated from time to time)
Ibexa BUL is granted by having a valid Ibexa DXP (formerly eZ Platform Enterprise) subscription,
as described at: https://www.ibexa.co/product
For the full Ibexa BUL license text, please see:
- LICENSE-bul file placed in the root of this source code, or
- https://www.ibexa.co/software-information/licenses-and-agreements (latest version applies)

AND

B - GNU General Public License, version 2
Grants an copyleft open source license with ABSOLUTELY NO WARRANTY. For the full GPL license text, please see:
- LICENSE file placed in the root of this source code, or
- https://www.gnu.org/licenses/old-licenses/gpl-2.0.html