Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
j-guyon committed Nov 7, 2019
1 parent f759f70 commit d6899bf
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ To use it, you have to enable contrib recipes on your project : `composer config
- Monitoring with timeout or failed commands (Json URL and command with mailing)
- Translated in french, english, german and spanish
- An [EasyAdmin](https://github.com/EasyCorp/EasyAdminBundle) configuration template available [here](Resources/doc/index.md#6---easyadmin-integration)
- **Beta** - Handle commands with a deamon (unix only) if you don't want to use a cronjob

## Screenshots
![list](Resources/doc/images/scheduled-list.png)
Expand Down
5 changes: 4 additions & 1 deletion Resources/doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ From this screen, you can do following actions :

When creating a new scheduling, you can provide your commands arguments and options exactly as you wold do from the console. Remember to use quotes when using arguments and options that includes white spaces.

After that, you have to set (every few minutes, it depends of your needs) the following command in your system crontab :
After that, **you have to set (every few minutes, it depends of your needs) the following command in your system crontab** :
``` bash
$ php bin/console scheduler:execute --env=env -vvv [--dump] [--no-output]
```
Expand All @@ -215,6 +215,9 @@ The `scheduler:execute` command will do following actions :
The `scheduler:unlock` command is capable of unlock all or a single scheduled command with a `lock-timeout` parameter.
It can be usefull if you don't have a full control about server restarting, which can a command in a lock state.

**Deamon (Beta)** : If you don't want to set up a cron job, you can use `scheduler:start` and `scheduler:stop` commands.
This commands manage a deamon process that will call `scheduler:execute` every minute. It require the `pcntl`php extension.
Note that with this mode, if a command with an error, it will stop all the scheduler.

**Note** : Each command is locked just before his execution (and unlocked after).
This system avoid to have simultaneous process for the same command.
Expand Down

0 comments on commit d6899bf

Please sign in to comment.