Skip to content

Commit 6c28e4f

Browse files
fix(docs): Add README.md with package information, quality code badges, and social links. (#30)
1 parent f212b19 commit 6c28e4f

File tree

3 files changed

+118
-1
lines changed

3 files changed

+118
-1
lines changed

.github/workflows/linter.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ name: linter
77

88
jobs:
99
linter:
10-
uses: php-forge/actions/.github/workflows/super-linter.yml@main
10+
uses: php-forge/actions/.github/workflows/super-linter.yml@v2
1111
permissions:
1212
checks: write
1313
contents: read

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# ChangeLog
2+
3+
## v1.0.0 September 13, 2025
4+
5+
- Enh #1: Add Apache, PHP `8.4`, PHP-FPM, and HTTP/2 support, image for Debian Trixie (@terabytesoftw)

README.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
<!-- markdownlint-disable MD041 -->
2+
<p align="center">
3+
<a href="https://github.com/yii2-extensions/docker-images" target="_blank">
4+
<img src="https://www.yiiframework.com/image/yii_logo_light.svg" alt="Yii Framework">
5+
</a>
6+
<h1 align="center">Docker images</h1>
7+
<br>
8+
</p>
9+
<!-- markdownlint-enable MD041 -->
10+
11+
Production-ready Docker images for Yii2 applications with Apache, PHP-FPM, and HTTP/2 support.
12+
13+
## Features
14+
15+
-**Apache 2.4** with HTTP/2, Brotli compression, and SSL/TLS
16+
-**Auto SSL** certificate generation for development
17+
-**Health checks** and monitoring endpoints
18+
-**PHP 8.4** with FPM and essential extensions (Redis, MongoDB, MySQL, PostgreSQL)
19+
-**Security hardened** with modern configurations
20+
-**Supervisor** for process management
21+
-**Three build variants**: `dev`, `prod`, and `full`
22+
23+
### Quick Start
24+
25+
Pull and run the image.
26+
27+
```bash
28+
# Development build with Xdebug
29+
docker run -d -p 8080:80 -v $(pwd):/var/www/app ghcr.io/yii2-extensions/apache:8.4-debian-dev-v1.0.0
30+
31+
# Production build with optimizations
32+
docker run -d -p 80:80 -p 443:443 -v $(pwd):/var/www/app ghcr.io/yii2-extensions/apache:8.4-debian-prod-v1.0.0
33+
34+
# Full testing build with all extensions
35+
docker run -d -p 8080:80 -v $(pwd):/var/www/app ghcr.io/yii2-extensions/apache:8.4-debian-full-v1.0.0
36+
```
37+
38+
### Docker Compose
39+
40+
Create a `docker-compose.yml` file.
41+
42+
<!-- editorconfig-checker-disable -->
43+
<!-- prettier-ignore-start -->
44+
```yaml
45+
version: '3.8'
46+
47+
services:
48+
web:
49+
image: ghcr.io/yii2-extensions/apache:8.4-debian-dev-v1.0.0
50+
ports:
51+
- "8080:80"
52+
- "8443:443"
53+
volumes:
54+
- .:/var/www/app
55+
environment:
56+
- YII_ENV=dev
57+
- YII_DEBUG=1
58+
```
59+
<!-- prettier-ignore-end -->
60+
<!-- editorconfig-checker-enable -->
61+
62+
### Build Variants
63+
64+
#### Development (`dev`)
65+
66+
```bash
67+
docker pull ghcr.io/yii2-extensions/apache:8.4-debian-dev-v1.0.0
68+
```
69+
70+
- Error reporting enabled with detailed logging
71+
- Node.js integration for asset compilation
72+
- OPcache with revalidation for development workflow
73+
- PHP `8.4` with Xdebug, Memcached, MongoDB, SOAP, YAML
74+
75+
#### Production (`prod`)
76+
77+
```bash
78+
docker pull ghcr.io/yii2-extensions/apache:8.4-debian-prod-v1.0.0
79+
```
80+
81+
- Minimal extension set with maximum performance
82+
- OPcache optimizations with disabled timestamp validation
83+
- Optimized for container orchestration platforms
84+
- Security hardening with reduced attack surface
85+
86+
#### Full Testing (`full`)
87+
88+
```bash
89+
docker pull ghcr.io/yii2-extensions/apache:8.4-debian-full-v1.0.0
90+
```
91+
92+
- All development extensions plus OCI8, SQL Server, Tidy
93+
- Complete extension matrix for comprehensive testing
94+
- Microsoft SQL Server ODBC drivers and PDO support
95+
- Production-like optimizations with development tools
96+
97+
## Package information
98+
99+
[![Docker Build](https://img.shields.io/github/actions/workflow/status/yii2-extensions/docker-images/build.yml?style=for-the-badge&logo=docker&logoColor=white&label=Docker%20Build)](https://github.com/yii2-extensions/docker-images/actions/workflows/build.yml)
100+
[![GitHub Release](https://img.shields.io/github/v/release/yii2-extensions/docker-images?style=for-the-badge&logo=git&logoColor=white&label=Release)](https://github.com/yii2-extensions/docker-images/releases)
101+
102+
## Quality code
103+
104+
[![Super-Linter](https://img.shields.io/github/actions/workflow/status/yii2-extensions/docker-images/linter.yml?style=for-the-badge&label=Super-Linter&logo=github)](https://github.com/yii2-extensions/docker-images/actions/workflows/linter.yml)
105+
106+
## Our social networks
107+
108+
[![Follow on X](https://img.shields.io/badge/-Follow%20on%20X-1DA1F2.svg?style=for-the-badge&logo=x&logoColor=white&labelColor=000000)](https://x.com/Terabytesoftw)
109+
110+
## License
111+
112+
[![License](https://img.shields.io/badge/License-BSD--3--Clause-brightgreen.svg?style=for-the-badge&logo=opensourceinitiative&logoColor=white&labelColor=555555)](LICENSE)

0 commit comments

Comments
 (0)