1# Redis configuration file example 2 3# Note on units: when memory size is needed, it is possible to specifiy 4# it in the usual form of 1k 5GB 4M and so forth: 5# 6# 1k => 1000 bytes 7# 1kb => 1024 bytes 8# 1m => 1000000 bytes 9# 1mb => 1024*1024 bytes 10# 1g => 1000000000 bytes 11# 1gb => 1024*1024*1024 bytes 12# 13# units are case insensitive so 1GB 1Gb 1gB are all the same. 14 15# Enable keyspace events notification for testing so that we cover more code. 16notify-keyspace-events yes 17 18# By default Redis does not run as a daemon. Use 'yes' if you need it. 19# Note that Redis will write a pid file in /var/run/redis.pid when daemonized. 20daemonize no 21 22# When running daemonized, Redis writes a pid file in /var/run/redis.pid by 23# default. You can specify a custom pid file location here. 24pidfile /var/run/redis.pid 25 26# Accept connections on the specified port, default is 6379. 27port 6379 28 29# If you want you can bind a single interface, if the bind option is not 30# specified all the interfaces will listen for incoming connections. 31# 32# bind 127.0.0.1 33 34# Specify the path for the unix socket that will be used to listen for 35# incoming connections. There is no default, so Redis will not listen 36# on a unix socket when not specified. 37# 38# unixsocket /tmp/redis.sock 39 40# Close the connection after a client is idle for N seconds (0 to disable) 41timeout 300 42 43# Set server verbosity to 'debug' 44# it can be one of: 45# debug (a lot of information, useful for development/testing) 46# verbose (many rarely useful info, but not a mess like the debug level) 47# notice (moderately verbose, what you want in production probably) 48# warning (only very important / critical messages are logged) 49loglevel verbose 50 51# Specify the log file name. Also 'stdout' can be used to force 52# Redis to log on the standard output. Note that if you use standard 53# output for logging but daemonize, logs will be sent to /dev/null 54logfile stdout 55 56# To enable logging to the system logger, just set 'syslog-enabled' to yes, 57# and optionally update the other syslog parameters to suit your needs. 58# syslog-enabled no 59 60# Specify the syslog identity. 61# syslog-ident redis 62 63# Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7. 64# syslog-facility local0 65 66# Set the number of databases. The default database is DB 0, you can select 67# a different one on a per-connection basis using SELECT <dbid> where 68# dbid is a number between 0 and 'databases'-1 69databases 16 70 71################################ SNAPSHOTTING ################################# 72# 73# Save the DB on disk: 74# 75# save <seconds> <changes> 76# 77# Will save the DB if both the given number of seconds and the given 78# number of write operations against the DB occurred. 79# 80# In the example below the behaviour will be to save: 81# after 900 sec (15 min) if at least 1 key changed 82# after 300 sec (5 min) if at least 10 keys changed 83# after 60 sec if at least 10000 keys changed 84# 85# Note: you can disable saving at all commenting all the "save" lines. 86 87save 900 1 88save 300 10 89save 60 10000 90 91# Compress string objects using LZF when dump .rdb databases? 92# For default that's set to 'yes' as it's almost always a win. 93# If you want to save some CPU in the saving child set it to 'no' but 94# the dataset will likely be bigger if you have compressible values or keys. 95rdbcompression yes 96 97# The filename where to dump the DB 98dbfilename dump.rdb 99 100# The working directory. 101# 102# The DB will be written inside this directory, with the filename specified 103# above using the 'dbfilename' configuration directive. 104# 105# Also the Append Only File will be created inside this directory. 106# 107# Note that you must specify a directory here, not a file name. 108dir ./ 109 110################################# REPLICATION ################################# 111 112# Master-Slave replication. Use slaveof to make a Redis instance a copy of 113# another Redis server. Note that the configuration is local to the slave 114# so for example it is possible to configure the slave to save the DB with a 115# different interval, or to listen to another port, and so on. 116# 117# slaveof <masterip> <masterport> 118 119# If the master is password protected (using the "requirepass" configuration 120# directive below) it is possible to tell the slave to authenticate before 121# starting the replication synchronization process, otherwise the master will 122# refuse the slave request. 123# 124# masterauth <master-password> 125 126# When a slave lost the connection with the master, or when the replication 127# is still in progress, the slave can act in two different ways: 128# 129# 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will 130# still reply to client requests, possibly with out of data data, or the 131# data set may just be empty if this is the first synchronization. 132# 133# 2) if slave-serve-stale data is set to 'no' the slave will reply with 134# an error "SYNC with master in progress" to all the kind of commands 135# but to INFO and SLAVEOF. 136# 137slave-serve-stale-data yes 138 139################################## SECURITY ################################### 140 141# Require clients to issue AUTH <PASSWORD> before processing any other 142# commands. This might be useful in environments in which you do not trust 143# others with access to the host running redis-server. 144# 145# This should stay commented out for backward compatibility and because most 146# people do not need auth (e.g. they run their own servers). 147# 148# Warning: since Redis is pretty fast an outside user can try up to 149# 150k passwords per second against a good box. This means that you should 150# use a very strong password otherwise it will be very easy to break. 151# 152# requirepass foobared 153 154# Command renaming. 155# 156# It is possilbe to change the name of dangerous commands in a shared 157# environment. For instance the CONFIG command may be renamed into something 158# of hard to guess so that it will be still available for internal-use 159# tools but not available for general clients. 160# 161# Example: 162# 163# rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52 164# 165# It is also possilbe to completely kill a command renaming it into 166# an empty string: 167# 168# rename-command CONFIG "" 169 170################################### LIMITS #################################### 171 172# Set the max number of connected clients at the same time. By default there 173# is no limit, and it's up to the number of file descriptors the Redis process 174# is able to open. The special value '0' means no limits. 175# Once the limit is reached Redis will close all the new connections sending 176# an error 'max number of clients reached'. 177# 178# maxclients 128 179 180# Don't use more memory than the specified amount of bytes. 181# When the memory limit is reached Redis will try to remove keys with an 182# EXPIRE set. It will try to start freeing keys that are going to expire 183# in little time and preserve keys with a longer time to live. 184# Redis will also try to remove objects from free lists if possible. 185# 186# If all this fails, Redis will start to reply with errors to commands 187# that will use more memory, like SET, LPUSH, and so on, and will continue 188# to reply to most read-only commands like GET. 189# 190# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a 191# 'state' server or cache, not as a real DB. When Redis is used as a real 192# database the memory usage will grow over the weeks, it will be obvious if 193# it is going to use too much memory in the long run, and you'll have the time 194# to upgrade. With maxmemory after the limit is reached you'll start to get 195# errors for write operations, and this may even lead to DB inconsistency. 196# 197# maxmemory <bytes> 198 199# MAXMEMORY POLICY: how Redis will select what to remove when maxmemory 200# is reached? You can select among five behavior: 201# 202# volatile-lru -> remove the key with an expire set using an LRU algorithm 203# allkeys-lru -> remove any key accordingly to the LRU algorithm 204# volatile-random -> remove a random key with an expire set 205# allkeys->random -> remove a random key, any key 206# volatile-ttl -> remove the key with the nearest expire time (minor TTL) 207# noeviction -> don't expire at all, just return an error on write operations 208# 209# Note: with all the kind of policies, Redis will return an error on write 210# operations, when there are not suitable keys for eviction. 211# 212# At the date of writing this commands are: set setnx setex append 213# incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd 214# sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby 215# zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby 216# getset mset msetnx exec sort 217# 218# The default is: 219# 220# maxmemory-policy volatile-lru 221 222# LRU and minimal TTL algorithms are not precise algorithms but approximated 223# algorithms (in order to save memory), so you can select as well the sample 224# size to check. For instance for default Redis will check three keys and 225# pick the one that was used less recently, you can change the sample size 226# using the following configuration directive. 227# 228# maxmemory-samples 3 229 230############################## APPEND ONLY MODE ############################### 231 232# By default Redis asynchronously dumps the dataset on disk. If you can live 233# with the idea that the latest records will be lost if something like a crash 234# happens this is the preferred way to run Redis. If instead you care a lot 235# about your data and don't want to that a single record can get lost you should 236# enable the append only mode: when this mode is enabled Redis will append 237# every write operation received in the file appendonly.aof. This file will 238# be read on startup in order to rebuild the full dataset in memory. 239# 240# Note that you can have both the async dumps and the append only file if you 241# like (you have to comment the "save" statements above to disable the dumps). 242# Still if append only mode is enabled Redis will load the data from the 243# log file at startup ignoring the dump.rdb file. 244# 245# IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append 246# log file in background when it gets too big. 247 248appendonly no 249 250# The name of the append only file (default: "appendonly.aof") 251# appendfilename appendonly.aof 252 253# The fsync() call tells the Operating System to actually write data on disk 254# instead to wait for more data in the output buffer. Some OS will really flush 255# data on disk, some other OS will just try to do it ASAP. 256# 257# Redis supports three different modes: 258# 259# no: don't fsync, just let the OS flush the data when it wants. Faster. 260# always: fsync after every write to the append only log . Slow, Safest. 261# everysec: fsync only if one second passed since the last fsync. Compromise. 262# 263# The default is "everysec" that's usually the right compromise between 264# speed and data safety. It's up to you to understand if you can relax this to 265# "no" that will will let the operating system flush the output buffer when 266# it wants, for better performances (but if you can live with the idea of 267# some data loss consider the default persistence mode that's snapshotting), 268# or on the contrary, use "always" that's very slow but a bit safer than 269# everysec. 270# 271# If unsure, use "everysec". 272 273# appendfsync always 274appendfsync everysec 275# appendfsync no 276 277# When the AOF fsync policy is set to always or everysec, and a background 278# saving process (a background save or AOF log background rewriting) is 279# performing a lot of I/O against the disk, in some Linux configurations 280# Redis may block too long on the fsync() call. Note that there is no fix for 281# this currently, as even performing fsync in a different thread will block 282# our synchronous write(2) call. 283# 284# In order to mitigate this problem it's possible to use the following option 285# that will prevent fsync() from being called in the main process while a 286# BGSAVE or BGREWRITEAOF is in progress. 287# 288# This means that while another child is saving the durability of Redis is 289# the same as "appendfsync none", that in pratical terms means that it is 290# possible to lost up to 30 seconds of log in the worst scenario (with the 291# default Linux settings). 292# 293# If you have latency problems turn this to "yes". Otherwise leave it as 294# "no" that is the safest pick from the point of view of durability. 295no-appendfsync-on-rewrite no 296 297############################### ADVANCED CONFIG ############################### 298 299# Hashes are encoded in a special way (much more memory efficient) when they 300# have at max a given number of elements, and the biggest element does not 301# exceed a given threshold. You can configure this limits with the following 302# configuration directives. 303hash-max-ziplist-entries 64 304hash-max-ziplist-value 512 305 306# Similarly to hashes, small lists are also encoded in a special way in order 307# to save a lot of space. The special representation is only used when 308# you are under the following limits: 309list-max-ziplist-entries 512 310list-max-ziplist-value 64 311 312# Sets have a special encoding in just one case: when a set is composed 313# of just strings that happens to be integers in radix 10 in the range 314# of 64 bit signed integers. 315# The following configuration setting sets the limit in the size of the 316# set in order to use this special memory saving encoding. 317set-max-intset-entries 512 318 319# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in 320# order to help rehashing the main Redis hash table (the one mapping top-level 321# keys to values). The hash table implementation redis uses (see dict.c) 322# performs a lazy rehashing: the more operation you run into an hash table 323# that is rehashing, the more rehashing "steps" are performed, so if the 324# server is idle the rehashing is never complete and some more memory is used 325# by the hash table. 326# 327# The default is to use this millisecond 10 times every second in order to 328# active rehashing the main dictionaries, freeing memory when possible. 329# 330# If unsure: 331# use "activerehashing no" if you have hard latency requirements and it is 332# not a good thing in your environment that Redis can reply form time to time 333# to queries with 2 milliseconds delay. 334# 335# use "activerehashing yes" if you don't have such hard requirements but 336# want to free memory asap when possible. 337activerehashing yes 338 339################################## INCLUDES ################################### 340 341# Include one or more other config files here. This is useful if you 342# have a standard template that goes to all redis server but also need 343# to customize a few per-server settings. Include files can include 344# other files, so use this wisely. 345# 346# include /path/to/local.conf 347# include /path/to/other.conf 348