|
| 1 | +# PHP Session Configuration |
| 2 | + |
| 3 | +This document explains how to configure PHP sessions in the docker-mailserver project, including both Redis and file-based session storage options. |
| 4 | + |
| 5 | +## Overview |
| 6 | + |
| 7 | +The web service supports configurable PHP session storage through environment variables. By default, sessions are stored in Redis, but you can easily switch to file-based storage or other session handlers. |
| 8 | + |
| 9 | +## Environment Variables |
| 10 | + |
| 11 | +| Variable | Default | Description | |
| 12 | +| -------------------------- | ---------------------------------------------------------- | -------------------- | |
| 13 | +| `PHP_SESSION_SAVE_HANDLER` | `redis` | Session save handler | |
| 14 | +| `PHP_SESSION_SAVE_PATH` | `tcp://${REDIS_HOST}:${REDIS_PORT}?auth=${REDIS_PASSWORD}` | Session save path | |
| 15 | + |
| 16 | +## Session Storage Options |
| 17 | + |
| 18 | +### Redis Sessions (Default) |
| 19 | + |
| 20 | +Redis is the default session storage mechanism, providing fast, scalable session management. |
| 21 | + |
| 22 | +**Configuration:** |
| 23 | + |
| 24 | +```bash |
| 25 | +PHP_SESSION_SAVE_HANDLER=redis |
| 26 | +PHP_SESSION_SAVE_PATH=tcp://${REDIS_HOST}:${REDIS_PORT}?auth=${REDIS_PASSWORD} |
| 27 | +``` |
| 28 | + |
| 29 | +### File-Based Sessions |
| 30 | + |
| 31 | +Store sessions as files on the local filesystem. |
| 32 | + |
| 33 | +**Configuration:** |
| 34 | + |
| 35 | +```bash |
| 36 | +PHP_SESSION_SAVE_HANDLER=files |
| 37 | +PHP_SESSION_SAVE_PATH=/tmp/sessions |
| 38 | +``` |
| 39 | + |
| 40 | +## Implementation Examples |
| 41 | + |
| 42 | +### Docker Compose Configuration |
| 43 | + |
| 44 | +**Redis Sessions (Default):** |
| 45 | + |
| 46 | +```yaml |
| 47 | +services: |
| 48 | + web: |
| 49 | + environment: |
| 50 | + - PHP_SESSION_SAVE_HANDLER=redis |
| 51 | + - PHP_SESSION_SAVE_PATH=tcp://redis:6379?auth=${REDIS_PASSWORD} |
| 52 | + depends_on: |
| 53 | + - redis |
| 54 | +``` |
| 55 | +
|
| 56 | +**File-Based Sessions:** |
| 57 | +
|
| 58 | +```yaml |
| 59 | +services: |
| 60 | + web: |
| 61 | + environment: |
| 62 | + - PHP_SESSION_SAVE_HANDLER=files |
| 63 | + - PHP_SESSION_SAVE_PATH=/tmp/sessions |
| 64 | + volumes: |
| 65 | + - session_data:/tmp/sessions |
| 66 | +``` |
| 67 | +
|
| 68 | +## PHP Configuration |
| 69 | +
|
| 70 | +The session configuration is applied through the PHP configuration file at: |
| 71 | +`target/web/rootfs/usr/local/etc/php/conf.d/zzz_app.ini` |
| 72 | + |
| 73 | +```ini |
| 74 | +session.save_handler = ${PHP_SESSION_SAVE_HANDLER} |
| 75 | +session.save_path = "${PHP_SESSION_SAVE_PATH:-tcp://${REDIS_HOST}:${REDIS_PORT}?auth=${REDIS_PASSWORD}}" |
| 76 | +``` |
| 77 | + |
| 78 | +This configuration: |
| 79 | + |
| 80 | +- Uses the `PHP_SESSION_SAVE_HANDLER` environment variable |
| 81 | +- Falls back to Redis configuration if `PHP_SESSION_SAVE_PATH` is not set |
0 commit comments