]> git.saurik.com Git - redis.git/blame - redis.conf
dict.c: added macros in dict.h to set signed and unsigned 64 bit values directly...
[redis.git] / redis.conf
CommitLineData
ed9b544e 1# Redis configuration file example
2
72324005 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
ed9b544e 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
029245fe 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.
ed329fcf
LH
21pidfile /var/run/redis.pid
22
a5639e7d 23# Accept connections on the specified port, default is 6379.
68d6345d 24# If port 0 is specified Redis will not listen on a TCP socket.
ed9b544e 25port 6379
26
27# If you want you can bind a single interface, if the bind option is not
029245fe 28# specified all the interfaces will listen for incoming connections.
ed9b544e 29#
30# bind 127.0.0.1
31
5d10923f
PN
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.
a5639e7d 35#
5d10923f 36# unixsocket /tmp/redis.sock
85238765 37# unixsocketperm 755
a5639e7d 38
0150db36 39# Close the connection after a client is idle for N seconds (0 to disable)
aba4adb7 40timeout 0
ed9b544e 41
121f70cf 42# Set server verbosity to 'debug'
43# it can be one of:
44# debug (a lot of information, useful for development/testing)
38aba9a1 45# verbose (many rarely useful info, but not a mess like the debug level)
121f70cf 46# notice (moderately verbose, what you want in production probably)
47# warning (only very important / critical messages are logged)
38aba9a1 48loglevel verbose
121f70cf 49
50# Specify the log file name. Also 'stdout' can be used to force
029245fe 51# Redis to log on the standard output. Note that if you use standard
121f70cf 52# output for logging but daemonize, logs will be sent to /dev/null
53logfile stdout
54
e1a586ee
JH
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
121f70cf 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#
ed9b544e 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
e7546c63 83#
84# Note: you can disable saving at all commenting all the "save" lines.
85
38aba9a1 86save 900 1
87save 300 10
88save 60 10000
ed9b544e 89
121f70cf 90# Compress string objects using LZF when dump .rdb databases?
b0553789 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
121f70cf 95
b8b553c8 96# The filename where to dump the DB
97dbfilename dump.rdb
98
029245fe 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.
ed9b544e 107dir ./
108
ed9b544e 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.
3f477979 115#
ed9b544e 116# slaveof <masterip> <masterport>
117
3f477979 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
4ebfc455 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
8996bf77 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#
f15e33a8 142# repl-ping-slave-period 10
8996bf77 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#
85ccd576 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#
f15e33a8 151# repl-timeout 60
8996bf77 152
f2aa84bd 153################################## SECURITY ###################################
154
155# Require clients to issue AUTH <PASSWORD> before processing any other
156# commands. This might be useful in environments in which you do not trust
157# others with access to the host running redis-server.
158#
159# This should stay commented out for backward compatibility and because most
160# people do not need auth (e.g. they run their own servers).
1b677732 161#
162# Warning: since Redis is pretty fast an outside user can try up to
163# 150k passwords per second against a good box. This means that you should
164# use a very strong password otherwise it will be very easy to break.
3f477979 165#
290deb8b 166# requirepass foobared
f2aa84bd 167
8d3e063a 168# Command renaming.
169#
170# It is possilbe to change the name of dangerous commands in a shared
171# environment. For instance the CONFIG command may be renamed into something
172# of hard to guess so that it will be still available for internal-use
173# tools but not available for general clients.
174#
175# Example:
176#
177# rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
178#
179# It is also possilbe to completely kill a command renaming it into
180# an empty string:
181#
182# rename-command CONFIG ""
183
285add55 184################################### LIMITS ####################################
185
58732c23 186# Set the max number of connected clients at the same time. By default
187# this limit is set to 10000 clients, however if the Redis server is not
188# able ot configure the process file limit to allow for the specified limit
189# the max number of allowed clients is set to the current file limit
190# minus 32 (as Redis reserves a few file descriptors for internal uses).
191#
285add55 192# Once the limit is reached Redis will close all the new connections sending
193# an error 'max number of clients reached'.
3f477979 194#
58732c23 195# maxclients 10000
285add55 196
3fd78bcd 197# Don't use more memory than the specified amount of bytes.
198# When the memory limit is reached Redis will try to remove keys with an
199# EXPIRE set. It will try to start freeing keys that are going to expire
200# in little time and preserve keys with a longer time to live.
201# Redis will also try to remove objects from free lists if possible.
202#
203# If all this fails, Redis will start to reply with errors to commands
204# that will use more memory, like SET, LPUSH, and so on, and will continue
205# to reply to most read-only commands like GET.
144d479b 206#
207# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
208# 'state' server or cache, not as a real DB. When Redis is used as a real
209# database the memory usage will grow over the weeks, it will be obvious if
210# it is going to use too much memory in the long run, and you'll have the time
211# to upgrade. With maxmemory after the limit is reached you'll start to get
212# errors for write operations, and this may even lead to DB inconsistency.
3f477979 213#
3fd78bcd 214# maxmemory <bytes>
215
165346ca 216# MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
217# is reached? You can select among five behavior:
218#
219# volatile-lru -> remove the key with an expire set using an LRU algorithm
220# allkeys-lru -> remove any key accordingly to the LRU algorithm
221# volatile-random -> remove a random key with an expire set
222# allkeys->random -> remove a random key, any key
223# volatile-ttl -> remove the key with the nearest expire time (minor TTL)
5402c426 224# noeviction -> don't expire at all, just return an error on write operations
225#
226# Note: with all the kind of policies, Redis will return an error on write
227# operations, when there are not suitable keys for eviction.
228#
229# At the date of writing this commands are: set setnx setex append
230# incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd
231# sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby
232# zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby
233# getset mset msetnx exec sort
234#
235# The default is:
165346ca 236#
237# maxmemory-policy volatile-lru
238
239# LRU and minimal TTL algorithms are not precise algorithms but approximated
240# algorithms (in order to save memory), so you can select as well the sample
241# size to check. For instance for default Redis will check three keys and
242# pick the one that was used less recently, you can change the sample size
243# using the following configuration directive.
244#
a3687929 245# maxmemory-samples 3
165346ca 246
44b38ef4 247############################## APPEND ONLY MODE ###############################
248
249# By default Redis asynchronously dumps the dataset on disk. If you can live
250# with the idea that the latest records will be lost if something like a crash
251# happens this is the preferred way to run Redis. If instead you care a lot
252# about your data and don't want to that a single record can get lost you should
253# enable the append only mode: when this mode is enabled Redis will append
4005fef1 254# every write operation received in the file appendonly.aof. This file will
44b38ef4 255# be read on startup in order to rebuild the full dataset in memory.
256#
257# Note that you can have both the async dumps and the append only file if you
258# like (you have to comment the "save" statements above to disable the dumps).
259# Still if append only mode is enabled Redis will load the data from the
260# log file at startup ignoring the dump.rdb file.
0154acdc 261#
49b99ab4 262# IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
263# log file in background when it gets too big.
44b38ef4 264
4e141d5a 265appendonly no
44b38ef4 266
f3b52411
PN
267# The name of the append only file (default: "appendonly.aof")
268# appendfilename appendonly.aof
269
4e141d5a 270# The fsync() call tells the Operating System to actually write data on disk
48f0308a 271# instead to wait for more data in the output buffer. Some OS will really flush
272# data on disk, some other OS will just try to do it ASAP.
273#
274# Redis supports three different modes:
275#
276# no: don't fsync, just let the OS flush the data when it wants. Faster.
277# always: fsync after every write to the append only log . Slow, Safest.
278# everysec: fsync only if one second passed since the last fsync. Compromise.
279#
6766f45e 280# The default is "everysec" that's usually the right compromise between
281# speed and data safety. It's up to you to understand if you can relax this to
282# "no" that will will let the operating system flush the output buffer when
283# it wants, for better performances (but if you can live with the idea of
284# some data loss consider the default persistence mode that's snapshotting),
285# or on the contrary, use "always" that's very slow but a bit safer than
286# everysec.
287#
288# If unsure, use "everysec".
289
290# appendfsync always
291appendfsync everysec
4e141d5a 292# appendfsync no
48f0308a 293
d5d23dab 294# When the AOF fsync policy is set to always or everysec, and a background
295# saving process (a background save or AOF log background rewriting) is
296# performing a lot of I/O against the disk, in some Linux configurations
297# Redis may block too long on the fsync() call. Note that there is no fix for
298# this currently, as even performing fsync in a different thread will block
299# our synchronous write(2) call.
300#
301# In order to mitigate this problem it's possible to use the following option
302# that will prevent fsync() from being called in the main process while a
303# BGSAVE or BGREWRITEAOF is in progress.
304#
305# This means that while another child is saving the durability of Redis is
306# the same as "appendfsync none", that in pratical terms means that it is
307# possible to lost up to 30 seconds of log in the worst scenario (with the
308# default Linux settings).
309#
310# If you have latency problems turn this to "yes". Otherwise leave it as
311# "no" that is the safest pick from the point of view of durability.
312no-appendfsync-on-rewrite no
313
b333e239 314# Automatic rewrite of the append only file.
315# Redis is able to automatically rewrite the log file implicitly calling
316# BGREWRITEAOF when the AOF log size will growth by the specified percentage.
317#
318# This is how it works: Redis remembers the size of the AOF file after the
319# latest rewrite (or if no rewrite happened since the restart, the size of
320# the AOF at startup is used).
321#
322# This base size is compared to the current size. If the current size is
323# bigger than the specified percentage, the rewrite is triggered. Also
324# you need to specify a minimal size for the AOF file to be rewritten, this
325# is useful to avoid rewriting the AOF file even if the percentage increase
326# is reached but it is still pretty small.
327#
328# Specify a precentage of zero in order to disable the automatic AOF
329# rewrite feature.
330
331auto-aof-rewrite-percentage 100
332auto-aof-rewrite-min-size 64mb
333
eeffcf38 334################################ LUA SCRIPTING ###############################
335
336# Max execution time of a Lua script in milliseconds.
115e3ff3 337#
338# If the maximum execution time is reached Redis will log that a script is
339# still in execution after the maxium allowed time and will start to
340# reply to queries with an error.
341#
342# The SHUTDOWN command will be available to shutdown the server without
343# violating the database consistency if the script entered an infinite loop.
344#
345# Set it to 0 or a negative value for unlimited execution without warnings.
346lua-time-limit 5000
eeffcf38 347
07c152a7 348################################ REDIS CLUSTER ###############################
349#
350# Normal Redis instances can't be part of a Redis Cluster, only nodes that are
351# started as cluster nodes can. In order to start a Redis instance as a
352# cluster node enable the cluster support uncommenting the following:
353#
354# cluster-enabled yes
355
356# Every cluster node has a cluster configuration file. This file is not
357# intended to be edited by hand. It is created and updated by Redis nodes.
358# Every Redis Cluster node requires a different cluster configuration file.
359# Make sure that instances running in the same system does not have
360# overlapping cluster configuration file names.
361#
362# cluster-config-file nodes-6379.conf
363
364# In order to setup your cluster make sure to read the documentation
365# available at http://redis.io web site.
366
35a60441 367################################## SLOW LOG ###################################
368
369# The Redis Slow Log is a system to log queries that exceeded a specified
370# execution time. The execution time does not include the I/O operations
371# like talking with the client, sending the reply and so forth,
372# but just the time needed to actually execute the command (this is the only
373# stage of command execution where the thread is blocked and can not serve
374# other requests in the meantime).
375#
376# You can configure the slow log with two parameters: one tells Redis
377# what is the execution time, in microseconds, to exceed in order for the
378# command to get logged, and the other parameter is the length of the
379# slow log. When a new command is logged the oldest one is removed from the
380# queue of logged commands.
381
de32c37c 382# The following time is expressed in microseconds, so 1000000 is equivalent
383# to one second. Note that a negative number disables the slow log, while
384# a value of zero forces the logging of every command.
35a60441 385slowlog-log-slower-than 10000
de32c37c 386
387# There is no limit to this length. Just be aware that it will consume memory.
388# You can reclaim memory used by the slow log with SLOWLOG RESET.
208092ad 389slowlog-max-len 1024
35a60441 390
ed9b544e 391############################### ADVANCED CONFIG ###############################
392
cbba7dd7 393# Hashes are encoded in a special way (much more memory efficient) when they
394# have at max a given numer of elements, and the biggest element does not
395# exceed a given threshold. You can configure this limits with the following
396# configuration directives.
b8cfcea4 397hash-max-zipmap-entries 512
398hash-max-zipmap-value 64
b3f83f12 399
6a246b1e 400# Similarly to hashes, small lists are also encoded in a special way in order
401# to save a lot of space. The special representation is only used when
402# you are under the following limits:
403list-max-ziplist-entries 512
404list-max-ziplist-value 64
405
406# Sets have a special encoding in just one case: when a set is composed
407# of just strings that happens to be integers in radix 10 in the range
408# of 64 bit signed integers.
409# The following configuration setting sets the limit in the size of the
410# set in order to use this special memory saving encoding.
411set-max-intset-entries 512
412
3ea204e1
PN
413# Similarly to hashes and lists, sorted sets are also specially encoded in
414# order to save a lot of space. This encoding is only used when the length and
415# elements of a sorted set are below the following limits:
416zset-max-ziplist-entries 128
417zset-max-ziplist-value 64
418
8ca3e9d1 419# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
420# order to help rehashing the main Redis hash table (the one mapping top-level
421# keys to values). The hash table implementation redis uses (see dict.c)
422# performs a lazy rehashing: the more operation you run into an hash table
423# that is rhashing, the more rehashing "steps" are performed, so if the
424# server is idle the rehashing is never complete and some more memory is used
425# by the hash table.
426#
427# The default is to use this millisecond 10 times every second in order to
428# active rehashing the main dictionaries, freeing memory when possible.
429#
430# If unsure:
431# use "activerehashing no" if you have hard latency requirements and it is
432# not a good thing in your environment that Redis can reply form time to time
433# to queries with 2 milliseconds delay.
434#
435# use "activerehashing yes" if you don't have such hard requirements but
436# want to free memory asap when possible.
437activerehashing yes
438
b3f83f12
JZ
439################################## INCLUDES ###################################
440
441# Include one or more other config files here. This is useful if you
442# have a standard template that goes to all redis server but also need
443# to customize a few per-server settings. Include files can include
444# other files, so use this wisely.
445#
446# include /path/to/local.conf
447# include /path/to/other.conf