Skip to content

Commit 307d3b1

Browse files
committed
Update README to reflect current configuration and available commands
This commit comprehensively updates the README documentation to align with the current implementation: - Update environment variables table with current naming and new options - Document environment-specific PHP configuration files (dev/prod) - Remove references to deprecated clean/clean-all commands - Clarify that enable-ssl automatically restarts the environment - Improve organization and descriptions throughout These changes ensure the documentation accurately represents the current functionality and configuration options of the environment.
1 parent cf4d9b8 commit 307d3b1

File tree

1 file changed

+34
-14
lines changed

1 file changed

+34
-14
lines changed

README.md

+34-14
Original file line numberDiff line numberDiff line change
@@ -124,19 +124,31 @@ Common configuration options:
124124

125125
| Variable | Description | Default (Dev) | Default (Prod) |
126126
|------------------------|---------------------------------------|----------------------|----------------------|
127-
| PHP_VERSION | PHP version to use | 8.3 | 8.3 |
128-
| PHP_TARGET | PHP image target | dev | base |
129-
| MYSQL_VERSION | MySQL version | 9.2 | 9.2 |
130-
| PHP_DISPLAY_ERRORS | Show PHP errors | 1 | 0 |
131-
| PHP_MEMORY_LIMIT | PHP memory limit | 256M | 128M |
132-
| XDEBUG_ENABLED | Enable Xdebug | 1 | 0 |
127+
| APP_NAME | Project name for Docker volumes | docker_nginx_php_mysql | docker_nginx_php_mysql |
133128
| APP_WORKSPACE | Workspace type | default | default |
134129
| APP_DIR | Application directory | app | app |
135130
| APP_PUBLIC_DIR | Public directory (auto-generated) | app/public | app/public |
136-
| PROJECT_NAME | Project name for Docker volumes | docker_nginx_php_mysql | docker_nginx_php_mysql |
137-
| MAILHOG_SMTP_PORT | MailHog SMTP port | 1025 | - |
138-
| MAILHOG_UI_PORT | MailHog web interface port | 8025 | - |
139-
| MAILHOG_STORAGE | MailHog storage mode | memory | - |
131+
| NGINX_HOST | Nginx server hostname | localhost | your-domain.com |
132+
| NGINX_PORT | Nginx HTTP port | 8000 | 8000 |
133+
| NGINX_SSL_PORT | Nginx HTTPS port | 3000 | 3000 |
134+
| PHP_VERSION | PHP version to use | 8.3 | 8.3 |
135+
| PHP_TARGET | PHP image target | dev | base |
136+
| PHP_INI | PHP configuration file | php.dev.ini | php.prod.ini |
137+
| XDEBUG_ENABLED | Enable Xdebug | 1 | 0 |
138+
| MYSQL_VERSION | MySQL version | 9.2 | 9.2 |
139+
| MYSQL_HOST | MySQL server hostname | mysql | mysql |
140+
| MYSQL_PORT | MySQL server port | 8989 | 8989 |
141+
| MYSQL_DATABASE | MySQL database name | test | production_db |
142+
| MYSQL_ROOT_PASSWORD | MySQL root password | root | [strong-password] |
143+
| MYSQL_USER | MySQL application user | dev | app_user |
144+
| MYSQL_PASSWORD | MySQL application password | dev | [strong-password] |
145+
| PHPMYADMIN_PORT | PHPMyAdmin web interface port | 8080 | none |
146+
| PHPMYADMIN_PROFILE | PHPMyAdmin Docker profile | dev | none |
147+
| MAILHOG_SMTP_PORT | MailHog SMTP port | 1025 | none |
148+
| MAILHOG_UI_PORT | MailHog web interface port | 8025 | none |
149+
| MAILHOG_PROFILE | MailHog Docker profile | dev | none |
150+
| APIDOCS_PORT | API docs web interface port | 8081 | none |
151+
| APIDOCS_PROFILE | API docs Docker profile | dev | none |
140152

141153
## 🔍 Debugging with Xdebug
142154

@@ -338,9 +350,6 @@ make gen-certs
338350
339351
# Enable SSL in Nginx configuration
340352
make enable-ssl
341-
342-
# Restart the environment
343-
make restart
344353
```
345354

346355
You can then access your site via HTTPS at [https://localhost:3000](https://localhost:3000).
@@ -541,7 +550,18 @@ You can add SQL scripts to `docker/mysql/init/` directory. These scripts will be
541550

542551
### Customizing PHP
543552

544-
To customize PHP settings, edit the `etc/php/php.ini` file.
553+
This environment uses separate PHP configuration files for development and production:
554+
555+
- `etc/php/php.dev.ini`: Development configuration with debug features enabled
556+
- `etc/php/php.prod.ini`: Production configuration optimized for performance and security
557+
558+
You can customize these files to adjust PHP settings for each environment. The appropriate file is selected based on the `PHP_INI` environment variable.
559+
560+
After changing any settings, restart the containers:
561+
562+
```bash
563+
make restart
564+
```
545565

546566
### Customizing Nginx
547567

0 commit comments

Comments
 (0)