68 lines
2.8 KiB
Markdown
68 lines
2.8 KiB
Markdown
# Kirby 3 Janitor
|
|
|
|
|
|
|
|
[](https://travis-ci.com/bnomei/kirby3-janitor)
|
|
[](https://coveralls.io/github/bnomei/kirby3-janitor)
|
|
[](https://codeclimate.com/github/bnomei/kirby3-janitor)
|
|
[](https://twitter.com/bnomei)
|
|
|
|
Kirby 3 Plugin for running jobs.
|
|
|
|
- It is a Panel Button!
|
|
- It has jobs build-in for cleaning the cache, sessions, create zip-backup, pre-generate thumbs, open URLs, refresh the current Panel page and more.
|
|
- You can define your own jobs (call API hooks, play a game, hack a server, ...)
|
|
- It can be triggered in your frontend code and with CRON.
|
|
- It can also be used as a CLI with fancy output.
|
|
- It can also create logs of what it did.
|
|
|
|
## Install
|
|
|
|
Using composer:
|
|
|
|
```bash
|
|
composer require bnomei/kirby3-janitor
|
|
```
|
|
|
|
Using git submodules:
|
|
|
|
```bash
|
|
git submodule add https://github.com/bnomei/kirby3-janitor.git site/plugins/kirby3-janitor
|
|
```
|
|
|
|
Using download & copy: download [the latest release](https://github.com/bnomei/kirby3-janitor/releases) and copy to `site/plugins`
|
|
|
|
## Commerical Usage
|
|
|
|
> <br>
|
|
><b>Support open source!</b><br><br>
|
|
> This plugin is free but if you use it in a commercial project please consider to sponsor me or make a donation.<br>
|
|
> If my work helped you to make some cash it seems fair to me that I might get a little reward as well, right?<br><br>
|
|
> Be kind. Share a little. Thanks.<br><br>
|
|
> ‐ Bruno<br>
|
|
>
|
|
|
|
| M | O | N | E | Y |
|
|
|---|----|---|---|---|
|
|
| [Github sponsor](https://github.com/sponsors/bnomei) | [Patreon](https://patreon.com/bnomei) | [Buy Me a Coffee](https://buymeacoff.ee/bnomei) | [Paypal dontation](https://www.paypal.me/bnomei/15) | [Hire me](mailto:b@bnomei.com?subject=Kirby) |
|
|
|
|
## Wiki
|
|
|
|
Continue to the [Janitor Wiki](https://github.com/bnomei/kirby3-janitor/wiki) to read more on how to install, setup and use this plugin.
|
|
|
|
## Dependencies
|
|
|
|
- [Symfony Finder](https://symfony.com/doc/current/components/finder.html)
|
|
- [CLIMate](https://github.com/thephpleague/climate)
|
|
|
|
## Disclaimer
|
|
|
|
This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please [create a new issue](https://github.com/bnomei/kirby3-janitor/issues/new).
|
|
|
|
## License
|
|
|
|
[MIT](https://opensource.org/licenses/MIT)
|
|
|
|
It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.
|
|
|