environment-setup.md

Environment Setup

To define where Postgres and Redis clients will connect to you can define the following environment variables:

• CLAY_STORAGE_POSTGRES_USER
• CLAY_STORAGE_POSTGRES_PASSWORD
• CLAY_STORAGE_POSTGRES_HOST
• CLAY_STORAGE_POSTGRES_PORT
• CLAY_STORAGE_POSTGRES_DB
• CLAY_STORAGE_POSTGRES_CACHE_ENABLED
• CLAY_STORAGE_POSTGRES_CACHE_HOST

---

Postgres

The following values are all used in the configuration of how to connect to your Postgres instance. These values default to a local setup but should be updated for production environments.

CLAY_STORAGE_POSTGRES_USER

Default: postgres (String)

CLAY_STORAGE_POSTGRES_PASSWORD

Default: example (String)

The password to use when connecting to Postgres

CLAY_STORAGE_POSTGRES_HOST

Default: localhost (String)

The host where your Postgres instance resides.

CLAY_STORAGE_POSTGRES_PORT

Default: 5432 (Number)

The port where your Postgres instance resides on its host.

CLAY_STORAGE_POSTGRES_DB

Default: clay (String)

The database within Postgres to connect to.

---

Redis

The following values pertain to the configuration of the Redis cashing layer within the module. If not configured, all values will be read from Postgres directly.

CLAY_STORAGE_POSTGRES_CACHE_ENABLED

Default: false (Boolean)

If set to true the module will leverage Redis as a cache for published data, uris, and user data to enable faster rendering of reader facing pages.

CLAY_STORAGE_POSTGRES_CACHE_HOST

Default: redis://localhost:6379 (String)

The Redis host to connect to. Should be Redis Protocol and include the port.

CLAY_STORAGE_POSTGRES_CACHE_TTL

Default: 86400 (Number)

This determines how long items will remain in the query cache (in seconds). The default is 24 hours.