Skip to content

Crontab: allow sudo with crontab:use_sudo option #3759

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
antonmedv merged 3 commits into from Dec 22, 2023
Merged

Crontab: allow sudo with crontab:use_sudo option #3759

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9050e1e
Add parameter crontab:use_sudo to allow running crontab using sudo.
Dec 21, 2023
98426fa
Add documentation and use cases for crontab:use_sudo
Dec 21, 2023
6ac252e
Regenerate documentation with docgen
Dec 21, 2023
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
13 changes: 10 additions & 3 deletions contrib/crontab.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@
return get('application', 'application');
});

// Use sudo to run crontab. When running crontab with sudo, you can use the `-u` parameter to change a crontab for a different user.
set('crontab:use_sudo', false);

desc('Sync crontab jobs');
task('crontab:sync', function () {
$cronJobsLocal = array_map(
Expand Down Expand Up @@ -80,6 +83,8 @@

function setRemoteCrontab(array $lines): void
{
$sudo = get('crontab:use_sudo') ? 'sudo' : '';

$tmpCrontabPath = sprintf('/tmp/%s', uniqid('crontab_save_'));

if (test("[ -f '$tmpCrontabPath' ]")) {
Expand All @@ -90,16 +95,18 @@ function setRemoteCrontab(array $lines): void
run("echo '" . $line . "' >> $tmpCrontabPath");
}

run('{{bin/crontab}} ' . $tmpCrontabPath);
run("$sudo {{bin/crontab}} " . $tmpCrontabPath);
run('unlink ' . $tmpCrontabPath);
}

function getRemoteCrontab(): array
{
if (!test("{{bin/crontab}} -l >> /dev/null 2>&1")) {
$sudo = get('crontab:use_sudo') ? 'sudo' : '';

if (!test("$sudo {{bin/crontab}} -l >> /dev/null 2>&1")) {
return [];
}

return explode(PHP_EOL, run("{{bin/crontab}} -l"));
return explode(PHP_EOL, run("$sudo {{bin/crontab}} -l"));
}

12 changes: 11 additions & 1 deletion docs/contrib/crontab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,21 @@ return get('application', 'application');
```


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

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

```php title="Default value"
false
```



## Tasks

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

Sync crontab jobs.

Expand Down