Skip to content

Fix #4036: Escape shell argument when setting remote crontab (7.x) #4046

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 29, 2025
Merged

Fix #4036: Escape shell argument when setting remote crontab (7.x) #4046

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion contrib/crontab.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@

namespace Deployer;

use function Deployer\Support\escape_shell_argument;

// Get path to bin
set('bin/crontab', function () {
return which('crontab');
Expand Down Expand Up @@ -95,7 +97,7 @@ function setRemoteCrontab(array $lines): void
}

foreach ($lines as $line) {
run("echo '" . $line . "' >> $tmpCrontabPath");
run("echo " . escape_shell_argument($line) . " >> $tmpCrontabPath");
}

run("$sudo {{bin/crontab}} " . $tmpCrontabPath);
Expand Down
21 changes: 4 additions & 17 deletions docs/contrib/crontab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,8 @@ add('crontab:jobs', [

## Configuration
### bin/crontab
[Source](https://github.com/deployphp/deployer/blob/master/contrib/crontab.php#L28)
[Source](https://github.com/deployphp/deployer/blob/master/contrib/crontab.php#L31)

Recipe for adding crontab jobs.
This recipe creates a new section in the crontab file with the configured jobs.
The section is identified by the *crontab:identifier* variable, by default the application name.
## Configuration
- *crontab:jobs* - An array of strings with crontab lines.
## Usage
```php
require 'contrib/crontab.php';
after('deploy:success', 'crontab:sync');
add('crontab:jobs', [
'* * * * * cd {{current_path}} && {{bin/php}} artisan schedule:run >> /dev/null 2>&1',
]);
```
Get path to bin

```php title="Default value"
Expand All @@ -52,7 +39,7 @@ return which('crontab');


### crontab:identifier
[Source](https://github.com/deployphp/deployer/blob/master/contrib/crontab.php#L33)
[Source](https://github.com/deployphp/deployer/blob/master/contrib/crontab.php#L36)

Set the identifier used in the crontab, application name by default

Expand All @@ -62,7 +49,7 @@ return get('application', 'application');


### crontab:use_sudo
[Source](https://github.com/deployphp/deployer/blob/master/contrib/crontab.php#L38)
[Source](https://github.com/deployphp/deployer/blob/master/contrib/crontab.php#L41)

Use sudo to run crontab. When running crontab with sudo, you can use the `-u` parameter to change a crontab for a different user.

Expand All @@ -75,7 +62,7 @@ false
## Tasks

### crontab:sync
[Source](https://github.com/deployphp/deployer/blob/master/contrib/crontab.php#L41)
[Source](https://github.com/deployphp/deployer/blob/master/contrib/crontab.php#L44)

Sync crontab jobs.

Expand Down