Skip to content

[5.x] Fix file headers #255

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

Merged
merged 1 commit into from
Jul 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
41 changes: 41 additions & 0 deletions .github/workflows/cleanup.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
################################################################################
# These setups are part of the project: https://code.shin.company/php
# Please respect the intellectual effort that went into creating them.
# If you use or copy these ideas, proper credit would be appreciated.
# - Author: SHIN Company <[email protected]>
# - License: https://code.shin.company/php/blob/main/LICENSE
################################################################################

name: Clean up

################################################################################
################################################################################

on:
workflow_dispatch:

################################################################################
################################################################################

jobs:
clean_up_ghcr:
runs-on: ubuntu-latest
steps:
- uses: dataaxiom/ghcr-cleanup-action@v1
with:
packages: 'shinsenter/*'
expand-packages: true
delete-untagged: true
- uses: dataaxiom/ghcr-cleanup-action@v1
with:
packages: 'shinsenter/*'
expand-packages: true
delete-partial-images: true
- uses: dataaxiom/ghcr-cleanup-action@v1
with:
packages: 'shinsenter/*'
expand-packages: true
older-than: 1 year

################################################################################
################################################################################
48 changes: 24 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -451,10 +451,10 @@ you'll need to configure SMTP using the following environment variables in your
| `SMTP_TLS` | Whether to use TLS for secure connection. | `on` |

> 💡 Hint: If you don't have an SMTP server available (like Gmail) to send emails,
> you can try using another container such as [MailHog](https://hub.docker.com/r/mailhog/mailhog) to act as an SMTP server.
> you can try using another container such as [Mailpit](https://hub.docker.com/r/axllent/mailpit) to act as an SMTP server.
>
> If you're using MailHog, you only need to set the following two environment variables
> in your container: `SMTP_HOST=mailhog` and `SMTP_PORT=25`.
> If you're using Mailpit, you only need to set the following two environment variables
> in your container: `SMTP_HOST=mailpit` and `SMTP_PORT=1025`.


## Debug Mode
Expand Down Expand Up @@ -483,30 +483,30 @@ services:

These Docker images include additional environment variables for fine-tuning container behavior:

| Setting Name | Default Value | Description | Example |
|------------------------------------|------------------|---------------------------------------------------------------------------------------------------------------------------------------|---------|
| `DEFAULT_LOG_PATH` | `/proc/1/fd/2` | Sets the log output path. By default, logs will be sent to the container's standard output. | `/var/log/container.txt` |
| `DEBUG` or `DEBUG_MODE` | Not set | Activates debug mode with more verbose logs when set to `1`. | 1 |
| `TZ` | `UTC` | Sets the default timezone for the container. [Full list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). | `Asia/Tokyo` |
| `ALLOW_RUNTIME_PHP_ENVVARS` | Not set | Enables the use of `$PHP_*` environment variables to dynamically change configurations when running PHP commands in the container. | 1 |
| Setting Name | Default Value | Description | Example |
|------------------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------|---------|
| `DEFAULT_LOG_PATH` | `/proc/1/fd/2` | Sets the log output path. By default, logs will be sent to the container's standard output. | `/var/log/container.txt` |
| `DEBUG` or `DEBUG_MODE` | Not set | Activates debug mode with more verbose logs when set to `1`. | `1` |
| `TZ` | `UTC` | Sets the default timezone for the container. [Full list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). | `Asia/Tokyo` |
| `ALLOW_RUNTIME_PHP_ENVVARS` | Not set | Enables the use of `$PHP_*` environment variables to dynamically change configurations when running PHP commands in the container. | `1` |
| `INITIAL_PROJECT` | Not set | Specifies a project for Composer to create in the application directory when it is empty.<br>※ If the value is a URL ending in `*.zip` or `*.tar.gz`, the container will download and extract the source code to the application directory. | `laravel/laravel` |
| `DISABLE_AUTORUN_SCRIPTS` | Not set | Disables all autorun scripts when set to `1`. | 0 |
| `DISABLE_AUTORUN_CREATING_PROJECT` | Not set | Prevents the creation of a new project when set to `1`. By default, Composer creates a project if `$INITIAL_PROJECT` is set and the application directory is empty. | 0 |
| `DISABLE_AUTORUN_COMPOSER_INSTALL` | Not set | Disables `composer install` at startup when set to `1`. By default, `composer install` runs at startup if `composer.json` is present but packages are missing. | 0 |
| `DISABLE_AUTORUN_GENERATING_INDEX` | Not set | Prevents the creation of `index.php` when set to `1`. By default, an `index.php` is created in the `$DOCUMENT_ROOT` directory if it doesn't exist. | 0 |
| `DISABLE_AUTORUN_FIX_OWNER_GROUP` | Not set | Disables automatic ownership correction of the application directory when set to "1". | 1 |
| `DISABLE_GREETING` | Not set | Disables the welcome message at container startup when set to `1`. | 0 |
| `ENABLE_CRONTAB` | Not set | Enables the Crontab service when set to `1`, loading settings from the directory defined by `$CRONTAB_DIR` (default is `/etc/crontab.d`). | 1 |
| `CRONTAB_DIR` | `/etc/crontab.d` | Specifies the directory containing cron job settings. Cron jobs are run as the user defined by `$APP_USER`. | `/path/for/crontab/schedules` |
| `CRONTAB_HOME` | `$APP_PATH` | Specifies the `$HOME` directory for cron jobs. | `/path/for/crontab` |
| `CRONTAB_MAILTO` | Not set | Email address to which cron job logs are sent. | `[email protected]` |
| `CRONTAB_PATH` | `$PATH` | Sets the directory paths for executing cron jobs. | `/path/for/crontab/bin` |
| `DISABLE_AUTORUN_SCRIPTS` | Not set | Disables all autorun scripts when set to `1`. | `0` |
| `DISABLE_AUTORUN_CREATING_PROJECT` | Not set | Prevents the creation of a new project when set to `1`. By default, Composer creates a project if `$INITIAL_PROJECT` is set and the application directory is empty. | `0` |
| `DISABLE_AUTORUN_COMPOSER_INSTALL` | Not set | Disables `composer install` at startup when set to `1`. By default, `composer install` runs at startup if `composer.json` is present but packages are missing. | `0` |
| `DISABLE_AUTORUN_GENERATING_INDEX` | Not set | Prevents the creation of `index.php` when set to `1`. By default, an `index.php` is created in the `$DOCUMENT_ROOT` directory if it doesn't exist. | `0` |
| `DISABLE_AUTORUN_FIX_OWNER_GROUP` | Not set | Disables automatic ownership correction of the application directory when set to "1". | `1` |
| `DISABLE_GREETING` | Not set | Disables the welcome message at container startup when set to `1`. | `0` |
| `ENABLE_CRONTAB` | Not set | Enables the Crontab service when set to `1`, loading settings from the directory defined by `$CRONTAB_DIR` (default is `/etc/crontab.d`). | `1` |
| `CRONTAB_DIR` | `/etc/crontab.d` | Specifies the directory containing cron job settings. Cron jobs are run as the user defined by `$APP_USER`. | `/path/for/crontab/schedules` |
| `CRONTAB_HOME` | `$APP_PATH` | Specifies the `$HOME` directory for cron jobs. | `/path/for/crontab` |
| `CRONTAB_MAILTO` | Not set | Email address to which cron job logs are sent. | `[email protected]` |
| `CRONTAB_PATH` | `$PATH` | Sets the directory paths for executing cron jobs. | `/path/for/crontab/bin` |
| `CRONTAB_SETTINGS` | Not set | Allows you to configure cron jobs directly in the docker-compose.yml file, making it easy to manage and update scheduled tasks within your Docker container. | `0 0 * * * echo "Hello new day!"` |
| `CRONTAB_SHELL` | `/bin/sh` | Sets the default shell for cron jobs. | `/bin/bash` |
| `CRONTAB_TZ` | `$TZ` | Sets the default timezone for cron jobs. [Full list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). | `Asia/Tokyo` |
| `CRONTAB_SHELL` | `/bin/sh` | Sets the default shell for cron jobs. | `/bin/bash` |
| `CRONTAB_TZ` | `$TZ` | Sets the default timezone for cron jobs. [Full list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). | `Asia/Tokyo` |
| `SUPERVISOR_PHP_COMMAND` | Not set | Contains the command that the container will use to serve your application instead of the default entrypoint command. | `php -S localhost:80 index.php` |
| `ENABLE_TUNING_FPM` | Not enabled | Enables auto-tuning of PM control settings when set to `1`. | 0 |
| `ENABLE_TUNING_MPM` | Not enabled | Enables auto-tuning of Apache MPM settings when set to `1`. | 0 |
| `ENABLE_TUNING_FPM` | Not enabled | Enables auto-tuning of PM control settings when set to `1`. | `0` |
| `ENABLE_TUNING_MPM` | Not enabled | Enables auto-tuning of Apache MPM settings when set to `1`. | `0` |


## Supported Platforms
Expand Down
4 changes: 2 additions & 2 deletions src/php/base-os.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
# These setups are part of the project: https://code.shin.company/php
# Please respect the intellectual effort that went into creating them.
# If you use or copy these ideas, proper credit would be appreciated.
# Author: SHIN Company <[email protected]>
# License: https://code.shin.company/php/blob/main/LICENSE
# - Author: SHIN Company <[email protected]>
# - License: https://code.shin.company/php/blob/main/LICENSE
################################################################################

# Enable SBOM attestations
Expand Down
4 changes: 2 additions & 2 deletions src/php/base-php.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
# These setups are part of the project: https://code.shin.company/php
# Please respect the intellectual effort that went into creating them.
# If you use or copy these ideas, proper credit would be appreciated.
# Author: SHIN Company <[email protected]>
# License: https://code.shin.company/php/blob/main/LICENSE
# - Author: SHIN Company <[email protected]>
# - License: https://code.shin.company/php/blob/main/LICENSE
################################################################################

# Enable SBOM attestations
Expand Down
4 changes: 2 additions & 2 deletions src/php/base-s6.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
# These setups are part of the project: https://code.shin.company/php
# Please respect the intellectual effort that went into creating them.
# If you use or copy these ideas, proper credit would be appreciated.
# Author: SHIN Company <[email protected]>
# License: https://code.shin.company/php/blob/main/LICENSE
# - Author: SHIN Company <[email protected]>
# - License: https://code.shin.company/php/blob/main/LICENSE
################################################################################

# Enable SBOM attestations
Expand Down
4 changes: 2 additions & 2 deletions src/php/common/docker-php-entrypoint
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
# These setups are part of the project: https://code.shin.company/php
# Please respect the intellectual effort that went into creating them.
# If you use or copy these ideas, proper credit would be appreciated.
# Author: SHIN Company <[email protected]>
# License: https://code.shin.company/php/blob/main/LICENSE
# - Author: SHIN Company <[email protected]>
# - License: https://code.shin.company/php/blob/main/LICENSE
################################################################################
if [ "$(id -u)" != "0" ]; then debug-echo -e "!!! Please run this container as the root user !!!" >&2; exit 1; fi

Expand Down
4 changes: 2 additions & 2 deletions src/php/common/os-base.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
# These setups are part of the project: https://code.shin.company/php
# Please respect the intellectual effort that went into creating them.
# If you use or copy these ideas, proper credit would be appreciated.
# Author: SHIN Company <[email protected]>
# License: https://code.shin.company/php/blob/main/LICENSE
# - Author: SHIN Company <[email protected]>
# - License: https://code.shin.company/php/blob/main/LICENSE
################################################################################

# set defaults from build arguments
Expand Down
4 changes: 2 additions & 2 deletions src/php/common/os-crontab.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
# These setups are part of the project: https://code.shin.company/php
# Please respect the intellectual effort that went into creating them.
# If you use or copy these ideas, proper credit would be appreciated.
# Author: SHIN Company <[email protected]>
# License: https://code.shin.company/php/blob/main/LICENSE
# - Author: SHIN Company <[email protected]>
# - License: https://code.shin.company/php/blob/main/LICENSE
################################################################################

# install crontab
Expand Down
4 changes: 2 additions & 2 deletions src/php/common/os-s6-overlay.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
# These setups are part of the project: https://code.shin.company/php
# Please respect the intellectual effort that went into creating them.
# If you use or copy these ideas, proper credit would be appreciated.
# Author: SHIN Company <[email protected]>
# License: https://code.shin.company/php/blob/main/LICENSE
# - Author: SHIN Company <[email protected]>
# - License: https://code.shin.company/php/blob/main/LICENSE
################################################################################

# S6 variables
Expand Down
4 changes: 2 additions & 2 deletions src/php/common/php-extensions.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
# These setups are part of the project: https://code.shin.company/php
# Please respect the intellectual effort that went into creating them.
# If you use or copy these ideas, proper credit would be appreciated.
# Author: SHIN Company <[email protected]>
# License: https://code.shin.company/php/blob/main/LICENSE
# - Author: SHIN Company <[email protected]>
# - License: https://code.shin.company/php/blob/main/LICENSE
################################################################################

# Get IPE script
Expand Down
4 changes: 2 additions & 2 deletions src/php/common/php-ini-directives.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
# These setups are part of the project: https://code.shin.company/php
# Please respect the intellectual effort that went into creating them.
# If you use or copy these ideas, proper credit would be appreciated.
# Author: SHIN Company <[email protected]>
# License: https://code.shin.company/php/blob/main/LICENSE
# - Author: SHIN Company <[email protected]>
# - License: https://code.shin.company/php/blob/main/LICENSE
################################################################################

# Here are php.ini directives we can set to configure our PHP setup
Expand Down
4 changes: 2 additions & 2 deletions src/php/common/rootfs/etc/hooks/bootstrap-non-s6/50-crontabs
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
# These setups are part of the project: https://code.shin.company/php
# Please respect the intellectual effort that went into creating them.
# If you use or copy these ideas, proper credit would be appreciated.
# Author: SHIN Company <[email protected]>
# License: https://code.shin.company/php/blob/main/LICENSE
# - Author: SHIN Company <[email protected]>
# - License: https://code.shin.company/php/blob/main/LICENSE
################################################################################

if has-cmd crond; then
Expand Down
4 changes: 2 additions & 2 deletions src/php/common/rootfs/etc/hooks/bootstrap/00-boot
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
# These setups are part of the project: https://code.shin.company/php
# Please respect the intellectual effort that went into creating them.
# If you use or copy these ideas, proper credit would be appreciated.
# Author: SHIN Company <[email protected]>
# License: https://code.shin.company/php/blob/main/LICENSE
# - Author: SHIN Company <[email protected]>
# - License: https://code.shin.company/php/blob/main/LICENSE
################################################################################

DEFAULT_USER="www-data"
Expand Down
4 changes: 2 additions & 2 deletions src/php/common/rootfs/etc/hooks/bootstrap/10-php-conf
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
# These setups are part of the project: https://code.shin.company/php
# Please respect the intellectual effort that went into creating them.
# If you use or copy these ideas, proper credit would be appreciated.
# Author: SHIN Company <[email protected]>
# License: https://code.shin.company/php/blob/main/LICENSE
# - Author: SHIN Company <[email protected]>
# - License: https://code.shin.company/php/blob/main/LICENSE
################################################################################

if has-cmd php && has-cmd php-envvars; then
Expand Down
4 changes: 2 additions & 2 deletions src/php/common/rootfs/etc/hooks/bootstrap/20-create-project
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
# These setups are part of the project: https://code.shin.company/php
# Please respect the intellectual effort that went into creating them.
# If you use or copy these ideas, proper credit would be appreciated.
# Author: SHIN Company <[email protected]>
# License: https://code.shin.company/php/blob/main/LICENSE
# - Author: SHIN Company <[email protected]>
# - License: https://code.shin.company/php/blob/main/LICENSE
################################################################################
if ! has-cmd php; then exit 0; fi

Expand Down
4 changes: 2 additions & 2 deletions src/php/common/rootfs/etc/hooks/bootstrap/20-missing-index
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
# These setups are part of the project: https://code.shin.company/php
# Please respect the intellectual effort that went into creating them.
# If you use or copy these ideas, proper credit would be appreciated.
# Author: SHIN Company <[email protected]>
# License: https://code.shin.company/php/blob/main/LICENSE
# - Author: SHIN Company <[email protected]>
# - License: https://code.shin.company/php/blob/main/LICENSE
################################################################################
if ! has-cmd php; then exit 0; fi

Expand Down
Loading