Skip to content
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.

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

Add doc for project startup scripts #939

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

martin-rueegg
Copy link

Per-Project Start-up Scripts

Goal

Document the new functionality of supporting per-project startup scripts. Project-specific start-up scripts have the advantage to be stored and managed project-wide. So developers working on the same project, do not have to worry about the installation of those scripts. A common use case would be cron jobs that are required for CMS (e.g. WordPress based projects) and other web applications (e.g. nextcloud or humhub).

Description

With this and it's associated PRs (devilbox/docker-php-fpm#263 and devilbox/docker-php-fpm#264) there is the possibility of placing startup scripts that are project-specific (and hence can be managed project-wide on multiple developer instances) in the folder .devilbox/autostart under the project's root.

As such resolves #438

@martin-rueegg
Copy link
Author

Please note: I have no clue how the rst files are rendered. So I have adapted the file with common sense. Please let me know if there's something that needs to be changed. Same applies for the PRs on the docker-php-fpm project.

@cytopia cytopia added the triage Needs triaging label Dec 18, 2022
@cytopia
Copy link
Owner

cytopia commented Dec 18, 2022

@martin-rueegg thanks for the PR. I will give this a thorough review.

@martin-rueegg
Copy link
Author

@martin-rueegg thanks for the PR. I will give this a thorough review.

Awesome, thanks.

What came to my mind was that maybe there are some security considerations to be made: does there exist a possibility for a project to inject malicious code? Would it be necessary to either

  • enable the feature globally in .env, or
  • not having a global flag but a comma-separated list of directory names

to enable the feature?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triage Needs triaging
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Please add cron support
2 participants