Skip to content

Commit 6beb697

Browse files
authored
Mark igbinary and msgpack as optional extensions (#22)
1 parent 7c974bc commit 6beb697

1 file changed

Lines changed: 4 additions & 5 deletions

File tree

docs/1.x/installation.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Before installing Relay, make sure the system meets the requirements:
1212

1313
- PHP 7.4+
1414
- Redis Server 6.2.7+
15-
- The `json`, `session`, `igbinary` and `msgpack` PHP extensions
15+
- The `json` and `session` PHP extensions
1616

1717
## macOS
1818

@@ -235,7 +235,7 @@ which php
235235

236236
### 3. PHP extensions
237237

238-
Next, make sure the PHP installation you picked in step 2 has the `json`, `igbinary` and `msgpack` extensions installed.
238+
Next, make sure the PHP installation you picked in step 2 has the `json` and `session` extensions installed. The `igbinary` and `msgpack` extensions are optional, however the `igbinary` serializer is recommended.
239239

240240
```bash
241241
/usr/bin/php -m | grep -e json -e igbinary -e msgpack
@@ -244,7 +244,7 @@ Next, make sure the PHP installation you picked in step 2 has the `json`, `igbin
244244
# msgpack
245245
```
246246

247-
If any of the extensions are missing, be sure to install them via `pecl` or the system's PHP package manager before continuing. _Do this for all PHP installations of step 2._
247+
If any of the required extensions are missing, be sure to install them via `pecl` or the system's PHP package manager before continuing. _Do this for all PHP installations of step 2._
248248

249249
### 4. Relay artifact
250250

@@ -372,8 +372,7 @@ That's it, enjoy!
372372

373373
### TLDR
374374

375-
First, ensure that the `json`, `igbinary` and `msgpack` PHP extensions are installed for all PHP installations (CLI, FPM, etc).
376-
Then make sure `zstd` and `lz4` are installed, as well as other required system libraries.
375+
First, ensure that the `json` and `session` PHP extensions are installed for all PHP installations (CLI, FPM, etc); the `igbinary` and `msgpack` extensions are optional. Then make sure `zstd` and `lz4` are installed, as well as other required system libraries.
377376

378377
```bash
379378
RELAY_VERSION="{{relay}}" # https://builds.r2.relay.so/meta/latest

0 commit comments

Comments
 (0)