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# By default Redis does not run as a daemon. Use 'yes' if you need it.
16# Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
17daemonize no
18
19# When running daemonized, Redis writes a pid file in /var/run/redis.pid by
20# default. You can specify a custom pid file location here.
21pidfile /var/run/redis.pid
22
23# Accept connections on the specified port, default is 6379.
24# If port 0 is specified Redis will not listen on a TCP socket.
25port 6379
26
27# If you want you can bind a single interface, if the bind option is not
28# specified all the interfaces will listen for incoming connections.
29#
30# bind 127.0.0.1
31
32# Specify the path for the unix socket that will be used to listen for
33# incoming connections. There is no default, so Redis will not listen
34# on a unix socket when not specified.
35#
36# unixsocket /tmp/redis.sock
37# unixsocketperm 755
38
39# Close the connection after a client is idle for N seconds (0 to disable)
40timeout 0
41
42# Set server verbosity to 'debug'
43# it can be one of:
44# debug (a lot of information, useful for development/testing)
45# verbose (many rarely useful info, but not a mess like the debug level)
46# notice (moderately verbose, what you want in production probably)
47# warning (only very important / critical messages are logged)
48loglevel verbose
49
50# Specify the log file name. Also 'stdout' can be used to force
51# Redis to log on the standard output. Note that if you use standard
52# output for logging but daemonize, logs will be sent to /dev/null
53logfile stdout
54
55# To enable logging to the system logger, just set 'syslog-enabled' to yes,
56# and optionally update the other syslog parameters to suit your needs.
57# syslog-enabled no
58
59# Specify the syslog identity.
60# syslog-ident redis
61
62# Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7.
63# syslog-facility local0
64
65# Set the number of databases. The default database is DB 0, you can select
66# a different one on a per-connection basis using SELECT <dbid> where
67# dbid is a number between 0 and 'databases'-1
68databases 16
69
70################################ SNAPSHOTTING #################################
71#
72# Save the DB on disk:
73#
74# save <seconds> <changes>
75#
76# Will save the DB if both the given number of seconds and the given
77# number of write operations against the DB occurred.
78#
79# In the example below the behaviour will be to save:
80# after 900 sec (15 min) if at least 1 key changed
81# after 300 sec (5 min) if at least 10 keys changed
82# after 60 sec if at least 10000 keys changed
83#
84# Note: you can disable saving at all commenting all the "save" lines.
85
86save 900 1
87save 300 10
88save 60 10000
89
90# Compress string objects using LZF when dump .rdb databases?
91# For default that's set to 'yes' as it's almost always a win.
92# If you want to save some CPU in the saving child set it to 'no' but
93# the dataset will likely be bigger if you have compressible values or keys.
94rdbcompression yes
95
96# The filename where to dump the DB
97dbfilename dump.rdb
98
99# The working directory.
100#
101# The DB will be written inside this directory, with the filename specified
102# above using the 'dbfilename' configuration directive.
103#
104# Also the Append Only File will be created inside this directory.
105#
106# Note that you must specify a directory here, not a file name.
107dir ./
108
109################################# REPLICATION #################################
110
111# Master-Slave replication. Use slaveof to make a Redis instance a copy of
112# another Redis server. Note that the configuration is local to the slave
113# so for example it is possible to configure the slave to save the DB with a
114# different interval, or to listen to another port, and so on.
115#
116# slaveof <masterip> <masterport>
117
118# If the master is password protected (using the "requirepass" configuration
119# directive below) it is possible to tell the slave to authenticate before
120# starting the replication synchronization process, otherwise the master will
121# refuse the slave request.
122#
123# masterauth <master-password>
124
125# When a slave lost the connection with the master, or when the replication
126# is still in progress, the slave can act in two different ways:
127#
128# 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will
129# still reply to client requests, possibly with out of data data, or the
130# data set may just be empty if this is the first synchronization.
131#
132# 2) if slave-serve-stale data is set to 'no' the slave will reply with
133# an error "SYNC with master in progress" to all the kind of commands
134# but to INFO and SLAVEOF.
135#
136slave-serve-stale-data yes
137
138# Slaves send PINGs to server in a predefined interval. It's possible to change
139# this interval with the repl_ping_slave_period option. The default value is 10
140# seconds.
141#
142# repl-ping-slave-period 10
143
144# The following option sets a timeout for both Bulk transfer I/O timeout and
145# master data or ping response timeout. The default value is 60 seconds.
146#
147# It is important to make sure that this value is greater than the value
148# specified for repl-ping-slave-period otherwise a timeout will be detected
149# every time there is low traffic between the master and the slave.
150#
151# repl-timeout 60
152
153# The slave priority is an integer number published by Redis in the INFO output.
154# It is used by Redis Sentinel in order to select a slave to promote into a
155# master if the master is no longer working correctly.
156#
157# A slave with a low priority number is considered better for promotion, so
158# for instance if there are three slaves with priority 10, 100, 25 Sentinel will
159# pick the one wtih priority 10, that is the lowest.
160#
161# However a special priority of 0 marks the slave as not able to perform the
162# role of master, so a slave with priority of 0 will never be selected by
163# Redis Sentinel for promotion.
164#
165# By default the priority is 100.
166slave-priority 100
167
168################################## SECURITY ###################################
169
170# Require clients to issue AUTH <PASSWORD> before processing any other
171# commands. This might be useful in environments in which you do not trust
172# others with access to the host running redis-server.
173#
174# This should stay commented out for backward compatibility and because most
175# people do not need auth (e.g. they run their own servers).
176#
177# Warning: since Redis is pretty fast an outside user can try up to
178# 150k passwords per second against a good box. This means that you should
179# use a very strong password otherwise it will be very easy to break.
180#
181# requirepass foobared
182
183# Command renaming.
184#
185# It is possilbe to change the name of dangerous commands in a shared
186# environment. For instance the CONFIG command may be renamed into something
187# of hard to guess so that it will be still available for internal-use
188# tools but not available for general clients.
189#
190# Example:
191#
192# rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
193#
194# It is also possilbe to completely kill a command renaming it into
195# an empty string:
196#
197# rename-command CONFIG ""
198
199################################### LIMITS ####################################
200
201# Set the max number of connected clients at the same time. By default there
202# is no limit, and it's up to the number of file descriptors the Redis process
203# is able to open. The special value '0' means no limits.
204# Once the limit is reached Redis will close all the new connections sending
205# an error 'max number of clients reached'.
206#
207# maxclients 128
208
209# Don't use more memory than the specified amount of bytes.
210# When the memory limit is reached Redis will try to remove keys
211# accordingly to the eviction policy selected (see maxmemmory-policy).
212#
213# If Redis can't remove keys according to the policy, or if the policy is
214# set to 'noeviction', Redis will start to reply with errors to commands
215# that would use more memory, like SET, LPUSH, and so on, and will continue
216# to reply to read-only commands like GET.
217#
218# This option is usually useful when using Redis as an LRU cache, or to set
219# an hard memory limit for an instance (using the 'noeviction' policy).
220#
221# WARNING: If you have slaves attached to an instance with maxmemory on,
222# the size of the output buffers needed to feed the slaves are subtracted
223# from the used memory count, so that network problems / resyncs will
224# not trigger a loop where keys are evicted, and in turn the output
225# buffer of slaves is full with DELs of keys evicted triggering the deletion
226# of more keys, and so forth until the database is completely emptied.
227#
228# In short... if you have slaves attached it is suggested that you set a lower
229# limit for maxmemory so that there is some free RAM on the system for slave
230# output buffers (but this is not needed if the policy is 'noeviction').
231#
232# maxmemory <bytes>
233
234# MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
235# is reached? You can select among five behavior:
236#
237# volatile-lru -> remove the key with an expire set using an LRU algorithm
238# allkeys-lru -> remove any key accordingly to the LRU algorithm
239# volatile-random -> remove a random key with an expire set
240# allkeys->random -> remove a random key, any key
241# volatile-ttl -> remove the key with the nearest expire time (minor TTL)
242# noeviction -> don't expire at all, just return an error on write operations
243#
244# Note: with all the kind of policies, Redis will return an error on write
245# operations, when there are not suitable keys for eviction.
246#
247# At the date of writing this commands are: set setnx setex append
248# incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd
249# sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby
250# zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby
251# getset mset msetnx exec sort
252#
253# The default is:
254#
255# maxmemory-policy volatile-lru
256
257# LRU and minimal TTL algorithms are not precise algorithms but approximated
258# algorithms (in order to save memory), so you can select as well the sample
259# size to check. For instance for default Redis will check three keys and
260# pick the one that was used less recently, you can change the sample size
261# using the following configuration directive.
262#
263# maxmemory-samples 3
264
265############################## APPEND ONLY MODE ###############################
266
267# By default Redis asynchronously dumps the dataset on disk. If you can live
268# with the idea that the latest records will be lost if something like a crash
269# happens this is the preferred way to run Redis. If instead you care a lot
270# about your data and don't want to that a single record can get lost you should
271# enable the append only mode: when this mode is enabled Redis will append
272# every write operation received in the file appendonly.aof. This file will
273# be read on startup in order to rebuild the full dataset in memory.
274#
275# Note that you can have both the async dumps and the append only file if you
276# like (you have to comment the "save" statements above to disable the dumps).
277# Still if append only mode is enabled Redis will load the data from the
278# log file at startup ignoring the dump.rdb file.
279#
280# IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
281# log file in background when it gets too big.
282
283appendonly no
284
285# The name of the append only file (default: "appendonly.aof")
286# appendfilename appendonly.aof
287
288# The fsync() call tells the Operating System to actually write data on disk
289# instead to wait for more data in the output buffer. Some OS will really flush
290# data on disk, some other OS will just try to do it ASAP.
291#
292# Redis supports three different modes:
293#
294# no: don't fsync, just let the OS flush the data when it wants. Faster.
295# always: fsync after every write to the append only log . Slow, Safest.
296# everysec: fsync only if one second passed since the last fsync. Compromise.
297#
298# The default is "everysec" that's usually the right compromise between
299# speed and data safety. It's up to you to understand if you can relax this to
300# "no" that will will let the operating system flush the output buffer when
301# it wants, for better performances (but if you can live with the idea of
302# some data loss consider the default persistence mode that's snapshotting),
303# or on the contrary, use "always" that's very slow but a bit safer than
304# everysec.
305#
306# If unsure, use "everysec".
307
308# appendfsync always
309appendfsync everysec
310# appendfsync no
311
312# When the AOF fsync policy is set to always or everysec, and a background
313# saving process (a background save or AOF log background rewriting) is
314# performing a lot of I/O against the disk, in some Linux configurations
315# Redis may block too long on the fsync() call. Note that there is no fix for
316# this currently, as even performing fsync in a different thread will block
317# our synchronous write(2) call.
318#
319# In order to mitigate this problem it's possible to use the following option
320# that will prevent fsync() from being called in the main process while a
321# BGSAVE or BGREWRITEAOF is in progress.
322#
323# This means that while another child is saving the durability of Redis is
324# the same as "appendfsync none", that in pratical terms means that it is
325# possible to lost up to 30 seconds of log in the worst scenario (with the
326# default Linux settings).
327#
328# If you have latency problems turn this to "yes". Otherwise leave it as
329# "no" that is the safest pick from the point of view of durability.
330no-appendfsync-on-rewrite no
331
332# Automatic rewrite of the append only file.
333# Redis is able to automatically rewrite the log file implicitly calling
334# BGREWRITEAOF when the AOF log size will growth by the specified percentage.
335#
336# This is how it works: Redis remembers the size of the AOF file after the
337# latest rewrite (or if no rewrite happened since the restart, the size of
338# the AOF at startup is used).
339#
340# This base size is compared to the current size. If the current size is
341# bigger than the specified percentage, the rewrite is triggered. Also
342# you need to specify a minimal size for the AOF file to be rewritten, this
343# is useful to avoid rewriting the AOF file even if the percentage increase
344# is reached but it is still pretty small.
345#
346# Specify a precentage of zero in order to disable the automatic AOF
347# rewrite feature.
348
349auto-aof-rewrite-percentage 100
350auto-aof-rewrite-min-size 64mb
351
352################################## SLOW LOG ###################################
353
354# The Redis Slow Log is a system to log queries that exceeded a specified
355# execution time. The execution time does not include the I/O operations
356# like talking with the client, sending the reply and so forth,
357# but just the time needed to actually execute the command (this is the only
358# stage of command execution where the thread is blocked and can not serve
359# other requests in the meantime).
360#
361# You can configure the slow log with two parameters: one tells Redis
362# what is the execution time, in microseconds, to exceed in order for the
363# command to get logged, and the other parameter is the length of the
364# slow log. When a new command is logged the oldest one is removed from the
365# queue of logged commands.
366
367# The following time is expressed in microseconds, so 1000000 is equivalent
368# to one second. Note that a negative number disables the slow log, while
369# a value of zero forces the logging of every command.
370slowlog-log-slower-than 10000
371
372# There is no limit to this length. Just be aware that it will consume memory.
373# You can reclaim memory used by the slow log with SLOWLOG RESET.
374slowlog-max-len 128
375
376################################ VIRTUAL MEMORY ###############################
377
378### WARNING! Virtual Memory is deprecated in Redis 2.4
379### The use of Virtual Memory is strongly discouraged.
380
381# Virtual Memory allows Redis to work with datasets bigger than the actual
382# amount of RAM needed to hold the whole dataset in memory.
383# In order to do so very used keys are taken in memory while the other keys
384# are swapped into a swap file, similarly to what operating systems do
385# with memory pages.
386#
387# To enable VM just set 'vm-enabled' to yes, and set the following three
388# VM parameters accordingly to your needs.
389
390vm-enabled no
391# vm-enabled yes
392
393# This is the path of the Redis swap file. As you can guess, swap files
394# can't be shared by different Redis instances, so make sure to use a swap
395# file for every redis process you are running. Redis will complain if the
396# swap file is already in use.
397#
398# The best kind of storage for the Redis swap file (that's accessed at random)
399# is a Solid State Disk (SSD).
400#
401# *** WARNING *** if you are using a shared hosting the default of putting
402# the swap file under /tmp is not secure. Create a dir with access granted
403# only to Redis user and configure Redis to create the swap file there.
404vm-swap-file /tmp/redis.swap
405
406# vm-max-memory configures the VM to use at max the specified amount of
407# RAM. Everything that deos not fit will be swapped on disk *if* possible, that
408# is, if there is still enough contiguous space in the swap file.
409#
410# With vm-max-memory 0 the system will swap everything it can. Not a good
411# default, just specify the max amount of RAM you can in bytes, but it's
412# better to leave some margin. For instance specify an amount of RAM
413# that's more or less between 60 and 80% of your free RAM.
414vm-max-memory 0
415
416# Redis swap files is split into pages. An object can be saved using multiple
417# contiguous pages, but pages can't be shared between different objects.
418# So if your page is too big, small objects swapped out on disk will waste
419# a lot of space. If you page is too small, there is less space in the swap
420# file (assuming you configured the same number of total swap file pages).
421#
422# If you use a lot of small objects, use a page size of 64 or 32 bytes.
423# If you use a lot of big objects, use a bigger page size.
424# If unsure, use the default :)
425vm-page-size 32
426
427# Number of total memory pages in the swap file.
428# Given that the page table (a bitmap of free/used pages) is taken in memory,
429# every 8 pages on disk will consume 1 byte of RAM.
430#
431# The total swap size is vm-page-size * vm-pages
432#
433# With the default of 32-bytes memory pages and 134217728 pages Redis will
434# use a 4 GB swap file, that will use 16 MB of RAM for the page table.
435#
436# It's better to use the smallest acceptable value for your application,
437# but the default is large in order to work in most conditions.
438vm-pages 134217728
439
440# Max number of VM I/O threads running at the same time.
441# This threads are used to read/write data from/to swap file, since they
442# also encode and decode objects from disk to memory or the reverse, a bigger
443# number of threads can help with big objects even if they can't help with
444# I/O itself as the physical device may not be able to couple with many
445# reads/writes operations at the same time.
446#
447# The special value of 0 turn off threaded I/O and enables the blocking
448# Virtual Memory implementation.
449vm-max-threads 4
450
451############################### ADVANCED CONFIG ###############################
452
453# Hashes are encoded in a special way (much more memory efficient) when they
454# have at max a given numer of elements, and the biggest element does not
455# exceed a given threshold. You can configure this limits with the following
456# configuration directives.
457hash-max-zipmap-entries 512
458hash-max-zipmap-value 64
459
460# Similarly to hashes, small lists are also encoded in a special way in order
461# to save a lot of space. The special representation is only used when
462# you are under the following limits:
463list-max-ziplist-entries 512
464list-max-ziplist-value 64
465
466# Sets have a special encoding in just one case: when a set is composed
467# of just strings that happens to be integers in radix 10 in the range
468# of 64 bit signed integers.
469# The following configuration setting sets the limit in the size of the
470# set in order to use this special memory saving encoding.
471set-max-intset-entries 512
472
473# Similarly to hashes and lists, sorted sets are also specially encoded in
474# order to save a lot of space. This encoding is only used when the length and
475# elements of a sorted set are below the following limits:
476zset-max-ziplist-entries 128
477zset-max-ziplist-value 64
478
479# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
480# order to help rehashing the main Redis hash table (the one mapping top-level
481# keys to values). The hash table implementation redis uses (see dict.c)
482# performs a lazy rehashing: the more operation you run into an hash table
483# that is rhashing, the more rehashing "steps" are performed, so if the
484# server is idle the rehashing is never complete and some more memory is used
485# by the hash table.
486#
487# The default is to use this millisecond 10 times every second in order to
488# active rehashing the main dictionaries, freeing memory when possible.
489#
490# If unsure:
491# use "activerehashing no" if you have hard latency requirements and it is
492# not a good thing in your environment that Redis can reply form time to time
493# to queries with 2 milliseconds delay.
494#
495# use "activerehashing yes" if you don't have such hard requirements but
496# want to free memory asap when possible.
497activerehashing yes
498
499################################## INCLUDES ###################################
500
501# Include one or more other config files here. This is useful if you
502# have a standard template that goes to all redis server but also need
503# to customize a few per-server settings. Include files can include
504# other files, so use this wisely.
505#
506# include /path/to/local.conf
507# include /path/to/other.conf