Skip to content

Commit eea8c02

Browse files
shinsentershinsenter
authored
[5.x] Fix file headers (#255)
1 parent fa416de commit eea8c02

File tree

94 files changed

+249
-208
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+249
-208
lines changed

‎.github/workflows/cleanup.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
################################################################################
2+
# These setups are part of the project: https://code.shin.company/php
3+
# Please respect the intellectual effort that went into creating them.
4+
# If you use or copy these ideas, proper credit would be appreciated.
5+
# - Author: SHIN Company <[email protected]>
6+
# - License: https://code.shin.company/php/blob/main/LICENSE
7+
################################################################################
8+
9+
name: Clean up
10+
11+
################################################################################
12+
################################################################################
13+
14+
on:
15+
workflow_dispatch:
16+
17+
################################################################################
18+
################################################################################
19+
20+
jobs:
21+
clean_up_ghcr:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- uses: dataaxiom/ghcr-cleanup-action@v1
25+
with:
26+
packages: 'shinsenter/*'
27+
expand-packages: true
28+
delete-untagged: true
29+
- uses: dataaxiom/ghcr-cleanup-action@v1
30+
with:
31+
packages: 'shinsenter/*'
32+
expand-packages: true
33+
delete-partial-images: true
34+
- uses: dataaxiom/ghcr-cleanup-action@v1
35+
with:
36+
packages: 'shinsenter/*'
37+
expand-packages: true
38+
older-than: 1 year
39+
40+
################################################################################
41+
################################################################################

‎README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -451,10 +451,10 @@ you'll need to configure SMTP using the following environment variables in your
451451
| `SMTP_TLS` | Whether to use TLS for secure connection. | `on` |
452452

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

459459

460460
## Debug Mode
@@ -483,30 +483,30 @@ services:
483483

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

486-
| Setting Name | Default Value | Description | Example |
487-
|------------------------------------|------------------|---------------------------------------------------------------------------------------------------------------------------------------|---------|
488-
| `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` |
489-
| `DEBUG` or `DEBUG_MODE` | Not set | Activates debug mode with more verbose logs when set to `1`. | 1 |
490-
| `TZ` | `UTC` | Sets the default timezone for the container. [Full list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). | `Asia/Tokyo` |
491-
| `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 |
486+
| Setting Name | Default Value | Description | Example |
487+
|------------------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------|---------|
488+
| `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` |
489+
| `DEBUG` or `DEBUG_MODE` | Not set | Activates debug mode with more verbose logs when set to `1`. | `1` |
490+
| `TZ` | `UTC` | Sets the default timezone for the container. [Full list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). | `Asia/Tokyo` |
491+
| `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` |
492492
| `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` |
493-
| `DISABLE_AUTORUN_SCRIPTS` | Not set | Disables all autorun scripts when set to `1`. | 0 |
494-
| `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 |
495-
| `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 |
496-
| `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 |
497-
| `DISABLE_AUTORUN_FIX_OWNER_GROUP` | Not set | Disables automatic ownership correction of the application directory when set to "1". | 1 |
498-
| `DISABLE_GREETING` | Not set | Disables the welcome message at container startup when set to `1`. | 0 |
499-
| `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 |
500-
| `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` |
501-
| `CRONTAB_HOME` | `$APP_PATH` | Specifies the `$HOME` directory for cron jobs. | `/path/for/crontab` |
502-
| `CRONTAB_MAILTO` | Not set | Email address to which cron job logs are sent. | `[email protected]` |
503-
| `CRONTAB_PATH` | `$PATH` | Sets the directory paths for executing cron jobs. | `/path/for/crontab/bin` |
493+
| `DISABLE_AUTORUN_SCRIPTS` | Not set | Disables all autorun scripts when set to `1`. | `0` |
494+
| `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` |
495+
| `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` |
496+
| `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` |
497+
| `DISABLE_AUTORUN_FIX_OWNER_GROUP` | Not set | Disables automatic ownership correction of the application directory when set to "1". | `1` |
498+
| `DISABLE_GREETING` | Not set | Disables the welcome message at container startup when set to `1`. | `0` |
499+
| `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` |
500+
| `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` |
501+
| `CRONTAB_HOME` | `$APP_PATH` | Specifies the `$HOME` directory for cron jobs. | `/path/for/crontab` |
502+
| `CRONTAB_MAILTO` | Not set | Email address to which cron job logs are sent. | `[email protected]` |
503+
| `CRONTAB_PATH` | `$PATH` | Sets the directory paths for executing cron jobs. | `/path/for/crontab/bin` |
504504
| `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!"` |
505-
| `CRONTAB_SHELL` | `/bin/sh` | Sets the default shell for cron jobs. | `/bin/bash` |
506-
| `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` |
505+
| `CRONTAB_SHELL` | `/bin/sh` | Sets the default shell for cron jobs. | `/bin/bash` |
506+
| `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` |
507507
| `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` |
508-
| `ENABLE_TUNING_FPM` | Not enabled | Enables auto-tuning of PM control settings when set to `1`. | 0 |
509-
| `ENABLE_TUNING_MPM` | Not enabled | Enables auto-tuning of Apache MPM settings when set to `1`. | 0 |
508+
| `ENABLE_TUNING_FPM` | Not enabled | Enables auto-tuning of PM control settings when set to `1`. | `0` |
509+
| `ENABLE_TUNING_MPM` | Not enabled | Enables auto-tuning of Apache MPM settings when set to `1`. | `0` |
510510

511511

512512
## Supported Platforms

‎src/php/base-os.dockerfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
# These setups are part of the project: https://code.shin.company/php
44
# Please respect the intellectual effort that went into creating them.
55
# If you use or copy these ideas, proper credit would be appreciated.
6-
# Author: SHIN Company <[email protected]>
7-
# License: https://code.shin.company/php/blob/main/LICENSE
6+
# - Author: SHIN Company <[email protected]>
7+
# - License: https://code.shin.company/php/blob/main/LICENSE
88
################################################################################
99

1010
# Enable SBOM attestations

‎src/php/base-php.dockerfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
# These setups are part of the project: https://code.shin.company/php
44
# Please respect the intellectual effort that went into creating them.
55
# If you use or copy these ideas, proper credit would be appreciated.
6-
# Author: SHIN Company <[email protected]>
7-
# License: https://code.shin.company/php/blob/main/LICENSE
6+
# - Author: SHIN Company <[email protected]>
7+
# - License: https://code.shin.company/php/blob/main/LICENSE
88
################################################################################
99

1010
# Enable SBOM attestations

‎src/php/base-s6.dockerfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
# These setups are part of the project: https://code.shin.company/php
44
# Please respect the intellectual effort that went into creating them.
55
# If you use or copy these ideas, proper credit would be appreciated.
6-
# Author: SHIN Company <[email protected]>
7-
# License: https://code.shin.company/php/blob/main/LICENSE
6+
# - Author: SHIN Company <[email protected]>
7+
# - License: https://code.shin.company/php/blob/main/LICENSE
88
################################################################################
99

1010
# Enable SBOM attestations

‎src/php/common/docker-php-entrypoint

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
# These setups are part of the project: https://code.shin.company/php
44
# Please respect the intellectual effort that went into creating them.
55
# If you use or copy these ideas, proper credit would be appreciated.
6-
# Author: SHIN Company <[email protected]>
7-
# License: https://code.shin.company/php/blob/main/LICENSE
6+
# - Author: SHIN Company <[email protected]>
7+
# - License: https://code.shin.company/php/blob/main/LICENSE
88
################################################################################
99
if [ "$(id -u)" != "0" ]; then debug-echo -e "!!! Please run this container as the root user !!!" >&2; exit 1; fi
1010

‎src/php/common/os-base.dockerfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
# These setups are part of the project: https://code.shin.company/php
33
# Please respect the intellectual effort that went into creating them.
44
# If you use or copy these ideas, proper credit would be appreciated.
5-
# Author: SHIN Company <[email protected]>
6-
# License: https://code.shin.company/php/blob/main/LICENSE
5+
# - Author: SHIN Company <[email protected]>
6+
# - License: https://code.shin.company/php/blob/main/LICENSE
77
################################################################################
88

99
# set defaults from build arguments

‎src/php/common/os-crontab.dockerfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
# These setups are part of the project: https://code.shin.company/php
33
# Please respect the intellectual effort that went into creating them.
44
# If you use or copy these ideas, proper credit would be appreciated.
5-
# Author: SHIN Company <[email protected]>
6-
# License: https://code.shin.company/php/blob/main/LICENSE
5+
# - Author: SHIN Company <[email protected]>
6+
# - License: https://code.shin.company/php/blob/main/LICENSE
77
################################################################################
88

99
# install crontab

‎src/php/common/os-s6-overlay.dockerfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
# These setups are part of the project: https://code.shin.company/php
33
# Please respect the intellectual effort that went into creating them.
44
# If you use or copy these ideas, proper credit would be appreciated.
5-
# Author: SHIN Company <[email protected]>
6-
# License: https://code.shin.company/php/blob/main/LICENSE
5+
# - Author: SHIN Company <[email protected]>
6+
# - License: https://code.shin.company/php/blob/main/LICENSE
77
################################################################################
88

99
# S6 variables

‎src/php/common/php-extensions.dockerfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
# These setups are part of the project: https://code.shin.company/php
33
# Please respect the intellectual effort that went into creating them.
44
# If you use or copy these ideas, proper credit would be appreciated.
5-
# Author: SHIN Company <[email protected]>
6-
# License: https://code.shin.company/php/blob/main/LICENSE
5+
# - Author: SHIN Company <[email protected]>
6+
# - License: https://code.shin.company/php/blob/main/LICENSE
77
################################################################################
88

99
# Get IPE script

0 commit comments

Comments
 (0)