diff --git a/README.md b/README.md index 9f2a595..fc8e0bb 100644 --- a/README.md +++ b/README.md @@ -14,32 +14,57 @@ Available variables are listed below, along with default values (see `defaults/m redis_port: 6379 redis_bind_interface: 127.0.0.1 + +Port and interface on which Redis will listen. Set the interface to `0.0.0.0` to listen on all interfaces. + redis_unixsocket: '' + +If set, Redis will also listen on a local Unix socket. + redis_timeout: 300 +Close a connection after a client is idle `N` seconds. Set to `0` to disable timeout. + redis_loglevel: "notice" redis_logfile: /var/log/redis/redis-server.log +Log level and log location (valid levels are `debug`, `verbose`, `notice`, and `warning`). + redis_databases: 16 +The number of Redis databases. + # Set to an empty set to disable persistence (saving the DB to disk). redis_save: - 900 1 - 300 10 - 60 10000 +Snapshotting configuration; setting values in this list will save the database to disk if the given number of seconds (e.g. `900`) and the given number of write operations (e.g. `1`) have occurred. + redis_rdbcompression: "yes" redis_dbfilename: dump.rdb redis_dbdir: /var/lib/redis +Database compression and location configuration. + redis_appendonly: "no" + +The appendonly option, if enabled, affords better data durability guarantees, at the cost of slightly slower performance. + redis_appendfsync: "everysec" +Valid values are `always` (slower, safest), `everysec` (happy medium), or `no` (let the filesystem flush data when it wants, most risky). + redis_vm_enabled: "no" +Whether to enable the use of virtual memory/swapping. + # Add extra include files for local configuration/overrides. redis_includes: [] +Add extra include file paths to this list to include more/localized Redis configuration. + ## Dependencies None.