diff --git a/docs/product/relay/options.mdx b/docs/product/relay/options.mdx index b1d8211dba74c..c04f0937cf8ed 100644 --- a/docs/product/relay/options.mdx +++ b/docs/product/relay/options.mdx @@ -62,7 +62,7 @@ These settings fine tune caching of project states. | key | type | value | description | | ------------------------------- | ------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| spool.envelopes.path | String | default: `null` | The path to the spool file used to save envelopes to disk. If provided, enables on-disk spooling. Relay will create the directory structure if needed. Note that `~` is interpreted as a literal and not as the home directory. | +| spool.envelopes.path | String | default: `null` | The path to the spool file used to save envelopes to disk. If provided, enables on-disk spooling. Relay will create the directory structure if needed. Note that `~` is interpreted as a literal and not as the home directory. Note that only `/etc/relay` and `/work` are writable in the container. The path must be a subdirectory of one of these folders. | | spool.envelopes.max_memory_size | String | default: `500MB` | The maximum in-memory buffer for incoming envelopes. The buffer will be spooled to disk when the configured size is reached. | | spool.envelopes.max_disk_size | String | default: `500MB` | The maximum on-disk spool size. | | spool.envelopes.max_connections | Integer | default: `20` | The maximum number of connections in the pool to manage on-disk spooling. |