1 # Redis configuration file example
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:
9 # 1mb => 1024*1024 bytes
10 # 1g => 1000000000 bytes
11 # 1gb => 1024*1024*1024 bytes
13 # units are case insensitive so 1GB 1Gb 1gB are all the same.
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.
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.
21 pidfile /var/run/redis.pid
23 # Accept connections on the specified port, default is 6379.
26 # If you want you can bind a single interface, if the bind option is not
27 # specified all the interfaces will listen for incoming connections.
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.
35 # unixsocket /tmp/redis.sock
37 # Close the connection after a client is idle for N seconds (0 to disable)
40 # Set server verbosity to 'debug'
42 # debug (a lot of information, useful for development/testing)
43 # verbose (many rarely useful info, but not a mess like the debug level)
44 # notice (moderately verbose, what you want in production probably)
45 # warning (only very important / critical messages are logged)
48 # Specify the log file name. Also 'stdout' can be used to force
49 # Redis to log on the standard output. Note that if you use standard
50 # output for logging but daemonize, logs will be sent to /dev/null
53 # Set the number of databases. The default database is DB 0, you can select
54 # a different one on a per-connection basis using SELECT <dbid> where
55 # dbid is a number between 0 and 'databases'-1
58 ################################ SNAPSHOTTING #################################
60 # Save the DB on disk:
62 # save <seconds> <changes>
64 # Will save the DB if both the given number of seconds and the given
65 # number of write operations against the DB occurred.
67 # In the example below the behaviour will be to save:
68 # after 900 sec (15 min) if at least 1 key changed
69 # after 300 sec (5 min) if at least 10 keys changed
70 # after 60 sec if at least 10000 keys changed
72 # Note: you can disable saving at all commenting all the "save" lines.
78 # Compress string objects using LZF when dump .rdb databases?
79 # For default that's set to 'yes' as it's almost always a win.
80 # If you want to save some CPU in the saving child set it to 'no' but
81 # the dataset will likely be bigger if you have compressible values or keys.
84 # The filename where to dump the DB
87 # The working directory.
89 # The DB will be written inside this directory, with the filename specified
90 # above using the 'dbfilename' configuration directive.
92 # Also the Append Only File will be created inside this directory.
94 # Note that you must specify a directory here, not a file name.
97 ################################# REPLICATION #################################
99 # Master-Slave replication. Use slaveof to make a Redis instance a copy of
100 # another Redis server. Note that the configuration is local to the slave
101 # so for example it is possible to configure the slave to save the DB with a
102 # different interval, or to listen to another port, and so on.
104 # slaveof <masterip> <masterport>
106 # If the master is password protected (using the "requirepass" configuration
107 # directive below) it is possible to tell the slave to authenticate before
108 # starting the replication synchronization process, otherwise the master will
109 # refuse the slave request.
111 # masterauth <master-password>
113 # When a slave lost the connection with the master, or when the replication
114 # is still in progress, the slave can act in two different ways:
116 # 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will
117 # still reply to client requests, possibly with out of data data, or the
118 # data set may just be empty if this is the first synchronization.
120 # 2) if slave-serve-stale data is set to 'no' the slave will reply with
121 # an error "SYNC with master in progress" to all the kind of commands
122 # but to INFO and SLAVEOF.
124 slave-serve-stale-data yes
126 ################################## SECURITY ###################################
128 # Require clients to issue AUTH <PASSWORD> before processing any other
129 # commands. This might be useful in environments in which you do not trust
130 # others with access to the host running redis-server.
132 # This should stay commented out for backward compatibility and because most
133 # people do not need auth (e.g. they run their own servers).
135 # Warning: since Redis is pretty fast an outside user can try up to
136 # 150k passwords per second against a good box. This means that you should
137 # use a very strong password otherwise it will be very easy to break.
139 # requirepass foobared
143 # It is possilbe to change the name of dangerous commands in a shared
144 # environment. For instance the CONFIG command may be renamed into something
145 # of hard to guess so that it will be still available for internal-use
146 # tools but not available for general clients.
150 # rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
152 # It is also possilbe to completely kill a command renaming it into
155 # rename-command CONFIG ""
157 ################################### LIMITS ####################################
159 # Set the max number of connected clients at the same time. By default there
160 # is no limit, and it's up to the number of file descriptors the Redis process
161 # is able to open. The special value '0' means no limits.
162 # Once the limit is reached Redis will close all the new connections sending
163 # an error 'max number of clients reached'.
167 # Don't use more memory than the specified amount of bytes.
168 # When the memory limit is reached Redis will try to remove keys with an
169 # EXPIRE set. It will try to start freeing keys that are going to expire
170 # in little time and preserve keys with a longer time to live.
171 # Redis will also try to remove objects from free lists if possible.
173 # If all this fails, Redis will start to reply with errors to commands
174 # that will use more memory, like SET, LPUSH, and so on, and will continue
175 # to reply to most read-only commands like GET.
177 # WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
178 # 'state' server or cache, not as a real DB. When Redis is used as a real
179 # database the memory usage will grow over the weeks, it will be obvious if
180 # it is going to use too much memory in the long run, and you'll have the time
181 # to upgrade. With maxmemory after the limit is reached you'll start to get
182 # errors for write operations, and this may even lead to DB inconsistency.
186 # MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
187 # is reached? You can select among five behavior:
189 # volatile-lru -> remove the key with an expire set using an LRU algorithm
190 # allkeys-lru -> remove any key accordingly to the LRU algorithm
191 # volatile-random -> remove a random key with an expire set
192 # allkeys->random -> remove a random key, any key
193 # volatile-ttl -> remove the key with the nearest expire time (minor TTL)
194 # noeviction -> don't expire at all, just return an error on write operations
196 # Note: with all the kind of policies, Redis will return an error on write
197 # operations, when there are not suitable keys for eviction.
199 # At the date of writing this commands are: set setnx setex append
200 # incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd
201 # sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby
202 # zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby
203 # getset mset msetnx exec sort
207 # maxmemory-policy volatile-lru
209 # LRU and minimal TTL algorithms are not precise algorithms but approximated
210 # algorithms (in order to save memory), so you can select as well the sample
211 # size to check. For instance for default Redis will check three keys and
212 # pick the one that was used less recently, you can change the sample size
213 # using the following configuration directive.
215 # maxmemory-samples 3
217 ############################## APPEND ONLY MODE ###############################
219 # By default Redis asynchronously dumps the dataset on disk. If you can live
220 # with the idea that the latest records will be lost if something like a crash
221 # happens this is the preferred way to run Redis. If instead you care a lot
222 # about your data and don't want to that a single record can get lost you should
223 # enable the append only mode: when this mode is enabled Redis will append
224 # every write operation received in the file appendonly.aof. This file will
225 # be read on startup in order to rebuild the full dataset in memory.
227 # Note that you can have both the async dumps and the append only file if you
228 # like (you have to comment the "save" statements above to disable the dumps).
229 # Still if append only mode is enabled Redis will load the data from the
230 # log file at startup ignoring the dump.rdb file.
232 # IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
233 # log file in background when it gets too big.
237 # The name of the append only file (default: "appendonly.aof")
238 # appendfilename appendonly.aof
240 # The fsync() call tells the Operating System to actually write data on disk
241 # instead to wait for more data in the output buffer. Some OS will really flush
242 # data on disk, some other OS will just try to do it ASAP.
244 # Redis supports three different modes:
246 # no: don't fsync, just let the OS flush the data when it wants. Faster.
247 # always: fsync after every write to the append only log . Slow, Safest.
248 # everysec: fsync only if one second passed since the last fsync. Compromise.
250 # The default is "everysec" that's usually the right compromise between
251 # speed and data safety. It's up to you to understand if you can relax this to
252 # "no" that will will let the operating system flush the output buffer when
253 # it wants, for better performances (but if you can live with the idea of
254 # some data loss consider the default persistence mode that's snapshotting),
255 # or on the contrary, use "always" that's very slow but a bit safer than
258 # If unsure, use "everysec".
264 # When the AOF fsync policy is set to always or everysec, and a background
265 # saving process (a background save or AOF log background rewriting) is
266 # performing a lot of I/O against the disk, in some Linux configurations
267 # Redis may block too long on the fsync() call. Note that there is no fix for
268 # this currently, as even performing fsync in a different thread will block
269 # our synchronous write(2) call.
271 # In order to mitigate this problem it's possible to use the following option
272 # that will prevent fsync() from being called in the main process while a
273 # BGSAVE or BGREWRITEAOF is in progress.
275 # This means that while another child is saving the durability of Redis is
276 # the same as "appendfsync none", that in pratical terms means that it is
277 # possible to lost up to 30 seconds of log in the worst scenario (with the
278 # default Linux settings).
280 # If you have latency problems turn this to "yes". Otherwise leave it as
281 # "no" that is the safest pick from the point of view of durability.
282 no-appendfsync-on-rewrite no
284 ################################ VIRTUAL MEMORY ###############################
286 # Virtual Memory allows Redis to work with datasets bigger than the actual
287 # amount of RAM needed to hold the whole dataset in memory.
288 # In order to do so very used keys are taken in memory while the other keys
289 # are swapped into a swap file, similarly to what operating systems do
292 # To enable VM just set 'vm-enabled' to yes, and set the following three
293 # VM parameters accordingly to your needs.
298 # This is the path of the Redis swap file. As you can guess, swap files
299 # can't be shared by different Redis instances, so make sure to use a swap
300 # file for every redis process you are running. Redis will complain if the
301 # swap file is already in use.
303 # The best kind of storage for the Redis swap file (that's accessed at random)
304 # is a Solid State Disk (SSD).
306 # *** WARNING *** if you are using a shared hosting the default of putting
307 # the swap file under /tmp is not secure. Create a dir with access granted
308 # only to Redis user and configure Redis to create the swap file there.
309 vm-swap-file /tmp/redis.swap
311 # vm-max-memory configures the VM to use at max the specified amount of
312 # RAM. Everything that deos not fit will be swapped on disk *if* possible, that
313 # is, if there is still enough contiguous space in the swap file.
315 # With vm-max-memory 0 the system will swap everything it can. Not a good
316 # default, just specify the max amount of RAM you can in bytes, but it's
317 # better to leave some margin. For instance specify an amount of RAM
318 # that's more or less between 60 and 80% of your free RAM.
321 # Redis swap files is split into pages. An object can be saved using multiple
322 # contiguous pages, but pages can't be shared between different objects.
323 # So if your page is too big, small objects swapped out on disk will waste
324 # a lot of space. If you page is too small, there is less space in the swap
325 # file (assuming you configured the same number of total swap file pages).
327 # If you use a lot of small objects, use a page size of 64 or 32 bytes.
328 # If you use a lot of big objects, use a bigger page size.
329 # If unsure, use the default :)
332 # Number of total memory pages in the swap file.
333 # Given that the page table (a bitmap of free/used pages) is taken in memory,
334 # every 8 pages on disk will consume 1 byte of RAM.
336 # The total swap size is vm-page-size * vm-pages
338 # With the default of 32-bytes memory pages and 134217728 pages Redis will
339 # use a 4 GB swap file, that will use 16 MB of RAM for the page table.
341 # It's better to use the smallest acceptable value for your application,
342 # but the default is large in order to work in most conditions.
345 # Max number of VM I/O threads running at the same time.
346 # This threads are used to read/write data from/to swap file, since they
347 # also encode and decode objects from disk to memory or the reverse, a bigger
348 # number of threads can help with big objects even if they can't help with
349 # I/O itself as the physical device may not be able to couple with many
350 # reads/writes operations at the same time.
352 # The special value of 0 turn off threaded I/O and enables the blocking
353 # Virtual Memory implementation.
356 ############################### ADVANCED CONFIG ###############################
358 # Glue small output buffers together in order to send small replies in a
359 # single TCP packet. Uses a bit more CPU but most of the times it is a win
360 # in terms of number of queries per second. Use 'yes' if unsure.
363 # Hashes are encoded in a special way (much more memory efficient) when they
364 # have at max a given numer of elements, and the biggest element does not
365 # exceed a given threshold. You can configure this limits with the following
366 # configuration directives.
367 hash-max-zipmap-entries 64
368 hash-max-zipmap-value 512
370 # Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
371 # order to help rehashing the main Redis hash table (the one mapping top-level
372 # keys to values). The hash table implementation redis uses (see dict.c)
373 # performs a lazy rehashing: the more operation you run into an hash table
374 # that is rhashing, the more rehashing "steps" are performed, so if the
375 # server is idle the rehashing is never complete and some more memory is used
378 # The default is to use this millisecond 10 times every second in order to
379 # active rehashing the main dictionaries, freeing memory when possible.
382 # use "activerehashing no" if you have hard latency requirements and it is
383 # not a good thing in your environment that Redis can reply form time to time
384 # to queries with 2 milliseconds delay.
386 # use "activerehashing yes" if you don't have such hard requirements but
387 # want to free memory asap when possible.
390 ################################## INCLUDES ###################################
392 # Include one or more other config files here. This is useful if you
393 # have a standard template that goes to all redis server but also need
394 # to customize a few per-server settings. Include files can include
395 # other files, so use this wisely.
397 # include /path/to/local.conf
398 # include /path/to/other.conf