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.
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 # Close the connection after a client is idle for N seconds (0 to disable)
34 # Set server verbosity to 'debug'
36 # debug (a lot of information, useful for development/testing)
37 # verbose (many rarely useful info, but not a mess like the debug level)
38 # notice (moderately verbose, what you want in production probably)
39 # warning (only very important / critical messages are logged)
42 # Specify the log file name. Also 'stdout' can be used to force
43 # Redis to log on the standard output. Note that if you use standard
44 # output for logging but daemonize, logs will be sent to /dev/null
47 # Set the number of databases. The default database is DB 0, you can select
48 # a different one on a per-connection basis using SELECT <dbid> where
49 # dbid is a number between 0 and 'databases'-1
52 ################################ SNAPSHOTTING #################################
54 # Save the DB on disk:
56 # save <seconds> <changes>
58 # Will save the DB if both the given number of seconds and the given
59 # number of write operations against the DB occurred.
61 # In the example below the behaviour will be to save:
62 # after 900 sec (15 min) if at least 1 key changed
63 # after 300 sec (5 min) if at least 10 keys changed
64 # after 60 sec if at least 10000 keys changed
66 # Note: you can disable saving at all commenting all the "save" lines.
72 # Compress string objects using LZF when dump .rdb databases?
73 # For default that's set to 'yes' as it's almost always a win.
74 # If you want to save some CPU in the saving child set it to 'no' but
75 # the dataset will likely be bigger if you have compressible values or keys.
78 # The filename where to dump the DB
81 # The working directory.
83 # The DB will be written inside this directory, with the filename specified
84 # above using the 'dbfilename' configuration directive.
86 # Also the Append Only File will be created inside this directory.
88 # Note that you must specify a directory here, not a file name.
91 ################################# REPLICATION #################################
93 # Master-Slave replication. Use slaveof to make a Redis instance a copy of
94 # another Redis server. Note that the configuration is local to the slave
95 # so for example it is possible to configure the slave to save the DB with a
96 # different interval, or to listen to another port, and so on.
98 # slaveof <masterip> <masterport>
100 # If the master is password protected (using the "requirepass" configuration
101 # directive below) it is possible to tell the slave to authenticate before
102 # starting the replication synchronization process, otherwise the master will
103 # refuse the slave request.
105 # masterauth <master-password>
107 ################################## SECURITY ###################################
109 # Require clients to issue AUTH <PASSWORD> before processing any other
110 # commands. This might be useful in environments in which you do not trust
111 # others with access to the host running redis-server.
113 # This should stay commented out for backward compatibility and because most
114 # people do not need auth (e.g. they run their own servers).
116 # Warning: since Redis is pretty fast an outside user can try up to
117 # 150k passwords per second against a good box. This means that you should
118 # use a very strong password otherwise it will be very easy to break.
120 # requirepass foobared
122 ################################### LIMITS ####################################
124 # Set the max number of connected clients at the same time. By default there
125 # is no limit, and it's up to the number of file descriptors the Redis process
126 # is able to open. The special value '0' means no limits.
127 # Once the limit is reached Redis will close all the new connections sending
128 # an error 'max number of clients reached'.
132 # Don't use more memory than the specified amount of bytes.
133 # When the memory limit is reached Redis will try to remove keys with an
134 # EXPIRE set. It will try to start freeing keys that are going to expire
135 # in little time and preserve keys with a longer time to live.
136 # Redis will also try to remove objects from free lists if possible.
138 # If all this fails, Redis will start to reply with errors to commands
139 # that will use more memory, like SET, LPUSH, and so on, and will continue
140 # to reply to most read-only commands like GET.
142 # WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
143 # 'state' server or cache, not as a real DB. When Redis is used as a real
144 # database the memory usage will grow over the weeks, it will be obvious if
145 # it is going to use too much memory in the long run, and you'll have the time
146 # to upgrade. With maxmemory after the limit is reached you'll start to get
147 # errors for write operations, and this may even lead to DB inconsistency.
151 ############################## APPEND ONLY MODE ###############################
153 # By default Redis asynchronously dumps the dataset on disk. If you can live
154 # with the idea that the latest records will be lost if something like a crash
155 # happens this is the preferred way to run Redis. If instead you care a lot
156 # about your data and don't want to that a single record can get lost you should
157 # enable the append only mode: when this mode is enabled Redis will append
158 # every write operation received in the file appendonly.aof. This file will
159 # be read on startup in order to rebuild the full dataset in memory.
161 # Note that you can have both the async dumps and the append only file if you
162 # like (you have to comment the "save" statements above to disable the dumps).
163 # Still if append only mode is enabled Redis will load the data from the
164 # log file at startup ignoring the dump.rdb file.
166 # IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
167 # log file in background when it gets too big.
171 # The name of the append only file (default: "appendonly.aof")
172 # appendfilename appendonly.aof
174 # The fsync() call tells the Operating System to actually write data on disk
175 # instead to wait for more data in the output buffer. Some OS will really flush
176 # data on disk, some other OS will just try to do it ASAP.
178 # Redis supports three different modes:
180 # no: don't fsync, just let the OS flush the data when it wants. Faster.
181 # always: fsync after every write to the append only log . Slow, Safest.
182 # everysec: fsync only if one second passed since the last fsync. Compromise.
184 # The default is "everysec" that's usually the right compromise between
185 # speed and data safety. It's up to you to understand if you can relax this to
186 # "no" that will will let the operating system flush the output buffer when
187 # it wants, for better performances (but if you can live with the idea of
188 # some data loss consider the default persistence mode that's snapshotting),
189 # or on the contrary, use "always" that's very slow but a bit safer than
192 # If unsure, use "everysec".
198 ################################ VIRTUAL MEMORY ###############################
200 # Virtual Memory allows Redis to work with datasets bigger than the actual
201 # amount of RAM needed to hold the whole dataset in memory.
202 # In order to do so very used keys are taken in memory while the other keys
203 # are swapped into a swap file, similarly to what operating systems do
206 # To enable VM just set 'vm-enabled' to yes, and set the following three
207 # VM parameters accordingly to your needs.
209 diskstore-enabled yes
210 diskstore-path redis.ds
214 ############################### ADVANCED CONFIG ###############################
216 # Glue small output buffers together in order to send small replies in a
217 # single TCP packet. Uses a bit more CPU but most of the times it is a win
218 # in terms of number of queries per second. Use 'yes' if unsure.
221 # Hashes are encoded in a special way (much more memory efficient) when they
222 # have at max a given numer of elements, and the biggest element does not
223 # exceed a given threshold. You can configure this limits with the following
224 # configuration directives.
225 hash-max-zipmap-entries 64
226 hash-max-zipmap-value 512
228 # Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
229 # order to help rehashing the main Redis hash table (the one mapping top-level
230 # keys to values). The hash table implementation redis uses (see dict.c)
231 # performs a lazy rehashing: the more operation you run into an hash table
232 # that is rhashing, the more rehashing "steps" are performed, so if the
233 # server is idle the rehashing is never complete and some more memory is used
236 # The default is to use this millisecond 10 times every second in order to
237 # active rehashing the main dictionaries, freeing memory when possible.
240 # use "activerehashing no" if you have hard latency requirements and it is
241 # not a good thing in your environment that Redis can reply form time to time
242 # to queries with 2 milliseconds delay.
244 # use "activerehashing yes" if you don't have such hard requirements but
245 # want to free memory asap when possible.
248 ################################## INCLUDES ###################################
250 # Include one or more other config files here. This is useful if you
251 # have a standard template that goes to all redis server but also need
252 # to customize a few per-server settings. Include files can include
253 # other files, so use this wisely.
255 # include /path/to/local.conf
256 # include /path/to/other.conf