]> git.saurik.com Git - redis.git/blame - redis.conf
Re-use variable data in redis-benchmark
[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.
ed9b544e 24port 6379
25
26# If you want you can bind a single interface, if the bind option is not
029245fe 27# specified all the interfaces will listen for incoming connections.
ed9b544e 28#
29# bind 127.0.0.1
30
5d10923f
PN
31# Specify the path for the unix socket that will be used to listen for
32# incoming connections. There is no default, so Redis will not listen
33# on a unix socket when not specified.
a5639e7d 34#
5d10923f 35# unixsocket /tmp/redis.sock
a5639e7d 36
0150db36 37# Close the connection after a client is idle for N seconds (0 to disable)
ed9b544e 38timeout 300
39
121f70cf 40# Set server verbosity to 'debug'
41# it can be one of:
42# debug (a lot of information, useful for development/testing)
38aba9a1 43# verbose (many rarely useful info, but not a mess like the debug level)
121f70cf 44# notice (moderately verbose, what you want in production probably)
45# warning (only very important / critical messages are logged)
38aba9a1 46loglevel verbose
121f70cf 47
48# Specify the log file name. Also 'stdout' can be used to force
029245fe 49# Redis to log on the standard output. Note that if you use standard
121f70cf 50# output for logging but daemonize, logs will be sent to /dev/null
51logfile stdout
52
e1a586ee
JH
53# To enable logging to the system logger, just set 'syslog-enabled' to yes,
54# and optionally update the other syslog parameters to suit your needs.
55# syslog-enabled no
56
57# Specify the syslog identity.
58# syslog-ident redis
59
60# Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7.
61# syslog-facility local0
62
121f70cf 63# Set the number of databases. The default database is DB 0, you can select
64# a different one on a per-connection basis using SELECT <dbid> where
65# dbid is a number between 0 and 'databases'-1
66databases 16
67
68################################ SNAPSHOTTING #################################
69#
ed9b544e 70# Save the DB on disk:
71#
72# save <seconds> <changes>
73#
74# Will save the DB if both the given number of seconds and the given
75# number of write operations against the DB occurred.
76#
77# In the example below the behaviour will be to save:
78# after 900 sec (15 min) if at least 1 key changed
79# after 300 sec (5 min) if at least 10 keys changed
80# after 60 sec if at least 10000 keys changed
e7546c63 81#
82# Note: you can disable saving at all commenting all the "save" lines.
83
38aba9a1 84save 900 1
85save 300 10
86save 60 10000
ed9b544e 87
121f70cf 88# Compress string objects using LZF when dump .rdb databases?
b0553789 89# For default that's set to 'yes' as it's almost always a win.
90# If you want to save some CPU in the saving child set it to 'no' but
91# the dataset will likely be bigger if you have compressible values or keys.
92rdbcompression yes
121f70cf 93
b8b553c8 94# The filename where to dump the DB
95dbfilename dump.rdb
96
029245fe 97# The working directory.
98#
99# The DB will be written inside this directory, with the filename specified
100# above using the 'dbfilename' configuration directive.
101#
102# Also the Append Only File will be created inside this directory.
103#
104# Note that you must specify a directory here, not a file name.
ed9b544e 105dir ./
106
ed9b544e 107################################# REPLICATION #################################
108
109# Master-Slave replication. Use slaveof to make a Redis instance a copy of
110# another Redis server. Note that the configuration is local to the slave
111# so for example it is possible to configure the slave to save the DB with a
112# different interval, or to listen to another port, and so on.
3f477979 113#
ed9b544e 114# slaveof <masterip> <masterport>
115
3f477979 116# If the master is password protected (using the "requirepass" configuration
117# directive below) it is possible to tell the slave to authenticate before
118# starting the replication synchronization process, otherwise the master will
119# refuse the slave request.
120#
121# masterauth <master-password>
122
4ebfc455 123# When a slave lost the connection with the master, or when the replication
124# is still in progress, the slave can act in two different ways:
125#
126# 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will
127# still reply to client requests, possibly with out of data data, or the
128# data set may just be empty if this is the first synchronization.
129#
130# 2) if slave-serve-stale data is set to 'no' the slave will reply with
131# an error "SYNC with master in progress" to all the kind of commands
132# but to INFO and SLAVEOF.
133#
134slave-serve-stale-data yes
135
f2aa84bd 136################################## SECURITY ###################################
137
138# Require clients to issue AUTH <PASSWORD> before processing any other
139# commands. This might be useful in environments in which you do not trust
140# others with access to the host running redis-server.
141#
142# This should stay commented out for backward compatibility and because most
143# people do not need auth (e.g. they run their own servers).
1b677732 144#
145# Warning: since Redis is pretty fast an outside user can try up to
146# 150k passwords per second against a good box. This means that you should
147# use a very strong password otherwise it will be very easy to break.
3f477979 148#
290deb8b 149# requirepass foobared
f2aa84bd 150
8d3e063a 151# Command renaming.
152#
153# It is possilbe to change the name of dangerous commands in a shared
154# environment. For instance the CONFIG command may be renamed into something
155# of hard to guess so that it will be still available for internal-use
156# tools but not available for general clients.
157#
158# Example:
159#
160# rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
161#
162# It is also possilbe to completely kill a command renaming it into
163# an empty string:
164#
165# rename-command CONFIG ""
166
285add55 167################################### LIMITS ####################################
168
169# Set the max number of connected clients at the same time. By default there
170# is no limit, and it's up to the number of file descriptors the Redis process
92f8e882 171# is able to open. The special value '0' means no limits.
285add55 172# Once the limit is reached Redis will close all the new connections sending
173# an error 'max number of clients reached'.
3f477979 174#
285add55 175# maxclients 128
176
3fd78bcd 177# Don't use more memory than the specified amount of bytes.
178# When the memory limit is reached Redis will try to remove keys with an
179# EXPIRE set. It will try to start freeing keys that are going to expire
180# in little time and preserve keys with a longer time to live.
181# Redis will also try to remove objects from free lists if possible.
182#
183# If all this fails, Redis will start to reply with errors to commands
184# that will use more memory, like SET, LPUSH, and so on, and will continue
185# to reply to most read-only commands like GET.
144d479b 186#
187# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
188# 'state' server or cache, not as a real DB. When Redis is used as a real
189# database the memory usage will grow over the weeks, it will be obvious if
190# it is going to use too much memory in the long run, and you'll have the time
191# to upgrade. With maxmemory after the limit is reached you'll start to get
192# errors for write operations, and this may even lead to DB inconsistency.
3f477979 193#
3fd78bcd 194# maxmemory <bytes>
195
165346ca 196# MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
197# is reached? You can select among five behavior:
198#
199# volatile-lru -> remove the key with an expire set using an LRU algorithm
200# allkeys-lru -> remove any key accordingly to the LRU algorithm
201# volatile-random -> remove a random key with an expire set
202# allkeys->random -> remove a random key, any key
203# volatile-ttl -> remove the key with the nearest expire time (minor TTL)
5402c426 204# noeviction -> don't expire at all, just return an error on write operations
205#
206# Note: with all the kind of policies, Redis will return an error on write
207# operations, when there are not suitable keys for eviction.
208#
209# At the date of writing this commands are: set setnx setex append
210# incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd
211# sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby
212# zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby
213# getset mset msetnx exec sort
214#
215# The default is:
165346ca 216#
217# maxmemory-policy volatile-lru
218
219# LRU and minimal TTL algorithms are not precise algorithms but approximated
220# algorithms (in order to save memory), so you can select as well the sample
221# size to check. For instance for default Redis will check three keys and
222# pick the one that was used less recently, you can change the sample size
223# using the following configuration directive.
224#
a3687929 225# maxmemory-samples 3
165346ca 226
44b38ef4 227############################## APPEND ONLY MODE ###############################
228
229# By default Redis asynchronously dumps the dataset on disk. If you can live
230# with the idea that the latest records will be lost if something like a crash
231# happens this is the preferred way to run Redis. If instead you care a lot
232# about your data and don't want to that a single record can get lost you should
233# enable the append only mode: when this mode is enabled Redis will append
4005fef1 234# every write operation received in the file appendonly.aof. This file will
44b38ef4 235# be read on startup in order to rebuild the full dataset in memory.
236#
237# Note that you can have both the async dumps and the append only file if you
238# like (you have to comment the "save" statements above to disable the dumps).
239# Still if append only mode is enabled Redis will load the data from the
240# log file at startup ignoring the dump.rdb file.
0154acdc 241#
49b99ab4 242# IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
243# log file in background when it gets too big.
44b38ef4 244
4e141d5a 245appendonly no
44b38ef4 246
f3b52411
PN
247# The name of the append only file (default: "appendonly.aof")
248# appendfilename appendonly.aof
249
4e141d5a 250# The fsync() call tells the Operating System to actually write data on disk
48f0308a 251# instead to wait for more data in the output buffer. Some OS will really flush
252# data on disk, some other OS will just try to do it ASAP.
253#
254# Redis supports three different modes:
255#
256# no: don't fsync, just let the OS flush the data when it wants. Faster.
257# always: fsync after every write to the append only log . Slow, Safest.
258# everysec: fsync only if one second passed since the last fsync. Compromise.
259#
6766f45e 260# The default is "everysec" that's usually the right compromise between
261# speed and data safety. It's up to you to understand if you can relax this to
262# "no" that will will let the operating system flush the output buffer when
263# it wants, for better performances (but if you can live with the idea of
264# some data loss consider the default persistence mode that's snapshotting),
265# or on the contrary, use "always" that's very slow but a bit safer than
266# everysec.
267#
268# If unsure, use "everysec".
269
270# appendfsync always
271appendfsync everysec
4e141d5a 272# appendfsync no
48f0308a 273
d5d23dab 274# When the AOF fsync policy is set to always or everysec, and a background
275# saving process (a background save or AOF log background rewriting) is
276# performing a lot of I/O against the disk, in some Linux configurations
277# Redis may block too long on the fsync() call. Note that there is no fix for
278# this currently, as even performing fsync in a different thread will block
279# our synchronous write(2) call.
280#
281# In order to mitigate this problem it's possible to use the following option
282# that will prevent fsync() from being called in the main process while a
283# BGSAVE or BGREWRITEAOF is in progress.
284#
285# This means that while another child is saving the durability of Redis is
286# the same as "appendfsync none", that in pratical terms means that it is
287# possible to lost up to 30 seconds of log in the worst scenario (with the
288# default Linux settings).
289#
290# If you have latency problems turn this to "yes". Otherwise leave it as
291# "no" that is the safest pick from the point of view of durability.
292no-appendfsync-on-rewrite no
293
a35ddf12 294################################ VIRTUAL MEMORY ###############################
295
4ef8de8a 296# Virtual Memory allows Redis to work with datasets bigger than the actual
297# amount of RAM needed to hold the whole dataset in memory.
298# In order to do so very used keys are taken in memory while the other keys
299# are swapped into a swap file, similarly to what operating systems do
300# with memory pages.
301#
302# To enable VM just set 'vm-enabled' to yes, and set the following three
303# VM parameters accordingly to your needs.
c9e5c23d 304
305vm-enabled no
306# vm-enabled yes
4ef8de8a 307
054e426d 308# This is the path of the Redis swap file. As you can guess, swap files
309# can't be shared by different Redis instances, so make sure to use a swap
a0e7e5f5 310# file for every redis process you are running. Redis will complain if the
311# swap file is already in use.
054e426d 312#
a0e7e5f5 313# The best kind of storage for the Redis swap file (that's accessed at random)
314# is a Solid State Disk (SSD).
5921aa36 315#
316# *** WARNING *** if you are using a shared hosting the default of putting
317# the swap file under /tmp is not secure. Create a dir with access granted
318# only to Redis user and configure Redis to create the swap file there.
a0e7e5f5 319vm-swap-file /tmp/redis.swap
054e426d 320
4ef8de8a 321# vm-max-memory configures the VM to use at max the specified amount of
322# RAM. Everything that deos not fit will be swapped on disk *if* possible, that
323# is, if there is still enough contiguous space in the swap file.
38aba9a1 324#
ce833020 325# With vm-max-memory 0 the system will swap everything it can. Not a good
326# default, just specify the max amount of RAM you can in bytes, but it's
327# better to leave some margin. For instance specify an amount of RAM
328# that's more or less between 60 and 80% of your free RAM.
329vm-max-memory 0
4ef8de8a 330
331# Redis swap files is split into pages. An object can be saved using multiple
332# contiguous pages, but pages can't be shared between different objects.
333# So if your page is too big, small objects swapped out on disk will waste
334# a lot of space. If you page is too small, there is less space in the swap
335# file (assuming you configured the same number of total swap file pages).
336#
337# If you use a lot of small objects, use a page size of 64 or 32 bytes.
338# If you use a lot of big objects, use a bigger page size.
92f8e882 339# If unsure, use the default :)
ce833020 340vm-page-size 32
4ef8de8a 341
342# Number of total memory pages in the swap file.
343# Given that the page table (a bitmap of free/used pages) is taken in memory,
344# every 8 pages on disk will consume 1 byte of RAM.
345#
346# The total swap size is vm-page-size * vm-pages
347#
ce833020 348# With the default of 32-bytes memory pages and 134217728 pages Redis will
349# use a 4 GB swap file, that will use 16 MB of RAM for the page table.
38aba9a1 350#
351# It's better to use the smallest acceptable value for your application,
352# but the default is large in order to work in most conditions.
ce833020 353vm-pages 134217728
a35ddf12 354
92f8e882 355# Max number of VM I/O threads running at the same time.
356# This threads are used to read/write data from/to swap file, since they
357# also encode and decode objects from disk to memory or the reverse, a bigger
358# number of threads can help with big objects even if they can't help with
359# I/O itself as the physical device may not be able to couple with many
360# reads/writes operations at the same time.
72e9fd40 361#
362# The special value of 0 turn off threaded I/O and enables the blocking
363# Virtual Memory implementation.
92f8e882 364vm-max-threads 4
365
ed9b544e 366############################### ADVANCED CONFIG ###############################
367
368# Glue small output buffers together in order to send small replies in a
369# single TCP packet. Uses a bit more CPU but most of the times it is a win
370# in terms of number of queries per second. Use 'yes' if unsure.
371glueoutputbuf yes
10c43610 372
cbba7dd7 373# Hashes are encoded in a special way (much more memory efficient) when they
374# have at max a given numer of elements, and the biggest element does not
375# exceed a given threshold. You can configure this limits with the following
376# configuration directives.
377hash-max-zipmap-entries 64
378hash-max-zipmap-value 512
b3f83f12 379
6a246b1e 380# Similarly to hashes, small lists are also encoded in a special way in order
381# to save a lot of space. The special representation is only used when
382# you are under the following limits:
383list-max-ziplist-entries 512
384list-max-ziplist-value 64
385
386# Sets have a special encoding in just one case: when a set is composed
387# of just strings that happens to be integers in radix 10 in the range
388# of 64 bit signed integers.
389# The following configuration setting sets the limit in the size of the
390# set in order to use this special memory saving encoding.
391set-max-intset-entries 512
392
8ca3e9d1 393# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
394# order to help rehashing the main Redis hash table (the one mapping top-level
395# keys to values). The hash table implementation redis uses (see dict.c)
396# performs a lazy rehashing: the more operation you run into an hash table
397# that is rhashing, the more rehashing "steps" are performed, so if the
398# server is idle the rehashing is never complete and some more memory is used
399# by the hash table.
400#
401# The default is to use this millisecond 10 times every second in order to
402# active rehashing the main dictionaries, freeing memory when possible.
403#
404# If unsure:
405# use "activerehashing no" if you have hard latency requirements and it is
406# not a good thing in your environment that Redis can reply form time to time
407# to queries with 2 milliseconds delay.
408#
409# use "activerehashing yes" if you don't have such hard requirements but
410# want to free memory asap when possible.
411activerehashing yes
412
b3f83f12
JZ
413################################## INCLUDES ###################################
414
415# Include one or more other config files here. This is useful if you
416# have a standard template that goes to all redis server but also need
417# to customize a few per-server settings. Include files can include
418# other files, so use this wisely.
419#
420# include /path/to/local.conf
421# include /path/to/other.conf