Skip to content
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
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,43 @@ else {
}
```

## Redis session storage

This package now includes `Gt\Session\RedisHandler` for shared session storage.
It works with Redis-compatible backends such as Redis and Valkey, and is intended
for deployments where application nodes are disposable and session state needs to
survive traffic moving between servers.

`RedisHandler` expects `save_path` to be a DSN rather than a filesystem path.
It uses the `phpredis` extension at runtime.

Example production config:

```ini
[session]
handler=Gt\Session\RedisHandler
save_path=rediss://default:secret@example-redis.internal:25061/0?prefix=GT:&ttl=1440
name=GT
use_cookies=true
```

Supported DSN forms:

- `redis://host:6379`
- `redis://:password@host:6379/0`
- `redis://username:password@host:6379/0`
- `rediss://username:password@host:6379/0`

Useful query parameters:

- `prefix`: key prefix for stored sessions, defaults to `<session-name>:`
- `ttl`: session lifetime in seconds, defaults to `session.gc_maxlifetime`
- `timeout`: connection timeout in seconds
- `read_timeout`: socket read timeout in seconds
- `persistent=1`: enable persistent connections
- `persistent_id`: optional persistent connection pool id
- `verify_peer=0` / `verify_peer_name=0`: optional TLS verification flags

# Proudly sponsored by

[JetBrains Open Source sponsorship program](https://www.jetbrains.com/community/opensource/)
Expand Down
17 changes: 17 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,30 @@
"php": ">=8.2",
"phpgt/typesafegetter": "^1.3"
},
"suggest": {
"ext-redis": "Required to use Gt\\Session\\RedisHandler."
},
"require-dev": {
"phpstan/phpstan": "^2.1",
"phpunit/phpunit": "^10.1",
"phpmd/phpmd": "^2.13",
"squizlabs/php_codesniffer": "^3.7"
},

"scripts": {
"phpunit": "vendor/bin/phpunit --configuration phpunit.xml",
"phpunit:coverage": "XDEBUG_MODE=coverage vendor/bin/phpunit --configuration phpunit.xml --coverage-text",
"phpstan": "vendor/bin/phpstan analyse --level 6 src",
"phpcs": "vendor/bin/phpcs src --standard=phpcs.xml",
"phpmd": "vendor/bin/phpmd src/ text phpmd.xml",
"test": [
"@phpunit",
"@phpstan",
"@phpcs",
"@phpmd"
]
},

"autoload": {
"psr-4": {
"Gt\\Session\\": "./src"
Expand Down
Loading
Loading