enex-rcache - remote build cache implementation for Nx

This is an implementation of the Nx remote cache OpenAPI specification.

Configuration

enex-rcache takes its configuration from enviroment variables. Currently the following are supported:

• ENEX_CACHE_DIR (required) - The directory in which to store cache records

• ENEX_READ_TOKENS - Comma-separated list of tokens able to read from the cache, but not write to it.

  Note: If this list is empty, this cache does not have read-only users (i.e. all users must have read-write tokens).

• ENEX_READ_WRITE_TOKENS (required) - Comma-separated list of tokens to write to the cache. Writing implies being able to read.

• ENEX_BIND_ADDRESSES - comma-separated list of IP addresses to bind the service to. If empty the service will bind to all available interfaces.

• ENEX_MAX_CACHE_SIZE - the maximum size of the cache in bytes. If the cache exceeds that size, the least-recently used entries will be pruned to make room.

enex-rcache will try to read a .env file at startup in order to set the environment. Existing enviroment entries will take precedence over the contents of the .env file (so you can have a standard config in a file and override it from the environment, e.g. in containerized deployments).