2024-05-13 20:21:38 +00:00
|
|
|
# Redis configuration
|
2023-12-20 22:38:42 +00:00
|
|
|
Redis can be used for faster session data storage and retrieval. Here is how to set it up.
|
|
|
|
|
|
|
|
** Prerequisites:**
|
2024-05-13 20:21:38 +00:00
|
|
|
* Redis must be running and available by IP address.
|
|
|
|
* Authenticated access is assumed. You will need to know your Redis authentication string before continuing.
|
|
|
|
* Be able to edit the webserver .htconfig.php file
|
2023-12-20 22:38:42 +00:00
|
|
|
## Step 1: Edit the .htconfig.php file
|
2024-05-13 20:21:38 +00:00
|
|
|
The webserver app is configured using a _.htconfig.php_ file in the root folder of the installation. Navigate to your installation folder and open the .htconfig.php file with your preferred editor.
|
2023-12-20 22:38:42 +00:00
|
|
|
|
|
|
|
Append the following code to the bottom of the file.
|
|
|
|
|
2024-05-13 20:21:38 +00:00
|
|
|
```
|
|
|
|
// "Redis" must be capitalised here.
|
|
|
|
App::$config['system']['session_save_handler'] = "Redis";
|
|
|
|
App::$config['system']['session_save_path'] = "redis://IP-ADDRESS:6379?auth=PASSWORD";
|
|
|
|
```
|
2023-12-20 22:38:42 +00:00
|
|
|
|
2024-05-13 20:21:38 +00:00
|
|
|
Replace **IP-ADDRESS** with the IP address Redis is listening on, and **PASSWORD** with the authentication string used to access Redis.
|
2023-12-20 22:38:42 +00:00
|
|
|
|
|
|
|
## Step 2: Verify that Redis is receiving the sessions.
|
|
|
|
This assumes that Redis is listening on IP 127.0.0.1. Update to reflect the correct IP of your Redis service.
|
2024-02-07 19:50:19 +00:00
|
|
|
```
|
2024-05-13 20:21:38 +00:00
|
|
|
redis-cli -h IP-ADDRESS
|
2024-02-07 19:50:19 +00:00
|
|
|
```
|
2023-12-20 22:38:42 +00:00
|
|
|
The command will look something like this, and your command prompt will change.
|
2024-05-13 20:21:38 +00:00
|
|
|
|
|
|
|
```
|
|
|
|
redis-cli -h 127.0.0.1
|
|
|
|
127.0.0.1:6379>
|
|
|
|
```
|
|
|
|
|
2023-12-20 22:38:42 +00:00
|
|
|
In order to access the session keys, Redis will require password authorization to be submitted beforehand.
|
2024-05-13 20:21:38 +00:00
|
|
|
Replace "PASSWORD" in the command below with the Redis password.
|
2024-02-07 19:50:19 +00:00
|
|
|
```
|
2024-05-13 20:21:38 +00:00
|
|
|
auth PASSWORD
|
2024-02-07 19:50:19 +00:00
|
|
|
```
|
2024-05-13 20:21:38 +00:00
|
|
|
|
2023-12-20 22:38:42 +00:00
|
|
|
It will look something like this, with a small "OK" message at the end to confirm.
|
2024-05-13 20:21:38 +00:00
|
|
|
```
|
|
|
|
127.0.0.1:6379> auth dkdiidlsdifnlsvniefwnciwncl3j92h3vchlcnal3ijcli439d3gflvn:
|
|
|
|
ok
|
|
|
|
```
|
|
|
|
|
2023-12-20 22:38:42 +00:00
|
|
|
Now, you can view the session keys with this command:
|
2024-02-07 19:50:19 +00:00
|
|
|
```
|
|
|
|
keys *
|
|
|
|
```
|
2024-05-13 20:21:38 +00:00
|
|
|
|
2023-12-20 22:38:42 +00:00
|
|
|
It will show you all the session identifiers currently stored in Redis:
|
2024-05-13 20:21:38 +00:00
|
|
|
```
|
|
|
|
127.0.0.1:6379> keys *
|
|
|
|
1) "e9310b5ee224b70f8df649f6938c15d9"
|
|
|
|
2) "d2abb4549333b81c9a119dbb639c0357"
|
|
|
|
3) "8cc64f59b80fc95e4ed43078048dcabb"
|
|
|
|
127.0.0.1:6379>
|
|
|
|
```
|