Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 352 lines (306 sloc) 15.165 kb
ed9b544 Salvatore Sanfilippo first commit
antirez authored
1 # Redis configuration file example
2
7232400 Salvatore Sanfilippo new units for bytes specification
antirez authored
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
ed9b544 Salvatore Sanfilippo first commit
antirez authored
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.
17 daemonize no
18
029245f Salvatore Sanfilippo clarified a few messages in redis.conf
antirez authored
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.
ed329fc Luc Heinrich Allow to specify the pid file from the config file.
lucsky authored
21 pidfile /var/run/redis.pid
22
ed9b544 Salvatore Sanfilippo first commit
antirez authored
23 # Accept connections on the specified port, default is 6379
24 port 6379
25
26 # If you want you can bind a single interface, if the bind option is not
029245f Salvatore Sanfilippo clarified a few messages in redis.conf
antirez authored
27 # specified all the interfaces will listen for incoming connections.
ed9b544 Salvatore Sanfilippo first commit
antirez authored
28 #
29 # bind 127.0.0.1
30
0150db3 Aman Gupta Allow timeout=0 config to disable client timeouts
tmm1 authored
31 # Close the connection after a client is idle for N seconds (0 to disable)
ed9b544 Salvatore Sanfilippo first commit
antirez authored
32 timeout 300
33
121f70c Salvatore Sanfilippo lzf compression switched off by default now, with config file option to ...
antirez authored
34 # Set server verbosity to 'debug'
35 # it can be one of:
36 # debug (a lot of information, useful for development/testing)
38aba9a Salvatore Sanfilippo a new default redis.conf
antirez authored
37 # verbose (many rarely useful info, but not a mess like the debug level)
121f70c Salvatore Sanfilippo lzf compression switched off by default now, with config file option to ...
antirez authored
38 # notice (moderately verbose, what you want in production probably)
39 # warning (only very important / critical messages are logged)
38aba9a Salvatore Sanfilippo a new default redis.conf
antirez authored
40 loglevel verbose
121f70c Salvatore Sanfilippo lzf compression switched off by default now, with config file option to ...
antirez authored
41
42 # Specify the log file name. Also 'stdout' can be used to force
029245f Salvatore Sanfilippo clarified a few messages in redis.conf
antirez authored
43 # Redis to log on the standard output. Note that if you use standard
121f70c Salvatore Sanfilippo lzf compression switched off by default now, with config file option to ...
antirez authored
44 # output for logging but daemonize, logs will be sent to /dev/null
45 logfile stdout
46
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
50 databases 16
51
52 ################################ SNAPSHOTTING #################################
53 #
ed9b544 Salvatore Sanfilippo first commit
antirez authored
54 # Save the DB on disk:
55 #
56 # save <seconds> <changes>
57 #
58 # Will save the DB if both the given number of seconds and the given
59 # number of write operations against the DB occurred.
60 #
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
e7546c6 Salvatore Sanfilippo BGREWRITEAOF now works with swapping on
antirez authored
65 #
66 # Note: you can disable saving at all commenting all the "save" lines.
67
38aba9a Salvatore Sanfilippo a new default redis.conf
antirez authored
68 save 900 1
69 save 300 10
70 save 60 10000
ed9b544 Salvatore Sanfilippo first commit
antirez authored
71
121f70c Salvatore Sanfilippo lzf compression switched off by default now, with config file option to ...
antirez authored
72 # Compress string objects using LZF when dump .rdb databases?
b055378 Salvatore Sanfilippo LZF compression re-enabled by default, but with INIT_HTAB set to 0 to av...
antirez authored
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.
76 rdbcompression yes
121f70c Salvatore Sanfilippo lzf compression switched off by default now, with config file option to ...
antirez authored
77
b8b553c Salvatore Sanfilippo ability to specify a different file name for the DB
antirez authored
78 # The filename where to dump the DB
79 dbfilename dump.rdb
80
029245f Salvatore Sanfilippo clarified a few messages in redis.conf
antirez authored
81 # The working directory.
82 #
83 # The DB will be written inside this directory, with the filename specified
84 # above using the 'dbfilename' configuration directive.
85 #
86 # Also the Append Only File will be created inside this directory.
87 #
88 # Note that you must specify a directory here, not a file name.
ed9b544 Salvatore Sanfilippo first commit
antirez authored
89 dir ./
90
91 ################################# REPLICATION #################################
92
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.
3f47797 Salvatore Sanfilippo TODO list modified. What's planned for 1.4 is now written in the stone ;...
antirez authored
97 #
ed9b544 Salvatore Sanfilippo first commit
antirez authored
98 # slaveof <masterip> <masterport>
99
3f47797 Salvatore Sanfilippo TODO list modified. What's planned for 1.4 is now written in the stone ;...
antirez authored
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.
104 #
105 # masterauth <master-password>
106
f2aa84b Salvatore Sanfilippo Lua client added thanks to Daniele Alessandri
antirez authored
107 ################################## SECURITY ###################################
108
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.
112 #
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).
1b67773 Salvatore Sanfilippo CONFIG now can change appendfsync policy at run time
antirez authored
115 #
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.
3f47797 Salvatore Sanfilippo TODO list modified. What's planned for 1.4 is now written in the stone ;...
antirez authored
119 #
290deb8 Salvatore Sanfilippo TODO changes, minor change to default redis.conf
antirez authored
120 # requirepass foobared
f2aa84b Salvatore Sanfilippo Lua client added thanks to Daniele Alessandri
antirez authored
121
285add5 Salvatore Sanfilippo maxclients implemented, see redis.conf for details
antirez authored
122 ################################### LIMITS ####################################
123
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
92f8e88 Salvatore Sanfilippo non-blocking VM data structures, just a start
antirez authored
126 # is able to open. The special value '0' means no limits.
285add5 Salvatore Sanfilippo maxclients implemented, see redis.conf for details
antirez authored
127 # Once the limit is reached Redis will close all the new connections sending
128 # an error 'max number of clients reached'.
3f47797 Salvatore Sanfilippo TODO list modified. What's planned for 1.4 is now written in the stone ;...
antirez authored
129 #
285add5 Salvatore Sanfilippo maxclients implemented, see redis.conf for details
antirez authored
130 # maxclients 128
131
3fd78bc Salvatore Sanfilippo maxmemory implemented
antirez authored
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.
137 #
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.
144d479 Salvatore Sanfilippo minor fix for Solaris boxes
antirez authored
141 #
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.
3f47797 Salvatore Sanfilippo TODO list modified. What's planned for 1.4 is now written in the stone ;...
antirez authored
148 #
3fd78bc Salvatore Sanfilippo maxmemory implemented
antirez authored
149 # maxmemory <bytes>
150
165346c Salvatore Sanfilippo implemented different algorithms for maxmemory
antirez authored
151 # MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
152 # is reached? You can select among five behavior:
153 #
154 # volatile-lru -> remove the key with an expire set using an LRU algorithm
155 # allkeys-lru -> remove any key accordingly to the LRU algorithm
156 # volatile-random -> remove a random key with an expire set
157 # allkeys->random -> remove a random key, any key
158 # volatile-ttl -> remove the key with the nearest expire time (minor TTL)
159 #
160 # maxmemory-policy volatile-lru
161
162 # LRU and minimal TTL algorithms are not precise algorithms but approximated
163 # algorithms (in order to save memory), so you can select as well the sample
164 # size to check. For instance for default Redis will check three keys and
165 # pick the one that was used less recently, you can change the sample size
166 # using the following configuration directive.
167 #
168 # maxmemory-sample 3
169
44b38ef Salvatore Sanfilippo Initial implementation of append-only mode. Loading still not implemente...
antirez authored
170 ############################## APPEND ONLY MODE ###############################
171
172 # By default Redis asynchronously dumps the dataset on disk. If you can live
173 # with the idea that the latest records will be lost if something like a crash
174 # happens this is the preferred way to run Redis. If instead you care a lot
175 # about your data and don't want to that a single record can get lost you should
176 # enable the append only mode: when this mode is enabled Redis will append
4005fef Salvatore Sanfilippo Now PUBLISH commands are replicated to slaves
antirez authored
177 # every write operation received in the file appendonly.aof. This file will
44b38ef Salvatore Sanfilippo Initial implementation of append-only mode. Loading still not implemente...
antirez authored
178 # be read on startup in order to rebuild the full dataset in memory.
179 #
180 # Note that you can have both the async dumps and the append only file if you
181 # like (you have to comment the "save" statements above to disable the dumps).
182 # Still if append only mode is enabled Redis will load the data from the
183 # log file at startup ignoring the dump.rdb file.
0154acd Salvatore Sanfilippo appendfsync is now set to NO by default
antirez authored
184 #
49b99ab Salvatore Sanfilippo Changed the reply of BGSAVE and BGREWRITEAOF from +OK to a more meaningf...
antirez authored
185 # IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
186 # log file in background when it gets too big.
44b38ef Salvatore Sanfilippo Initial implementation of append-only mode. Loading still not implemente...
antirez authored
187
4e141d5 Salvatore Sanfilippo append only mode is now able to translate EXPIRE into EXPIREAT transpare...
antirez authored
188 appendonly no
44b38ef Salvatore Sanfilippo Initial implementation of append-only mode. Loading still not implemente...
antirez authored
189
f3b5241 Pieter Noordhuis make append only filename configurable
pietern authored
190 # The name of the append only file (default: "appendonly.aof")
191 # appendfilename appendonly.aof
192
4e141d5 Salvatore Sanfilippo append only mode is now able to translate EXPIRE into EXPIREAT transpare...
antirez authored
193 # The fsync() call tells the Operating System to actually write data on disk
48f0308 Salvatore Sanfilippo support for appendonly mode no, always, everysec
antirez authored
194 # instead to wait for more data in the output buffer. Some OS will really flush
195 # data on disk, some other OS will just try to do it ASAP.
196 #
197 # Redis supports three different modes:
198 #
199 # no: don't fsync, just let the OS flush the data when it wants. Faster.
200 # always: fsync after every write to the append only log . Slow, Safest.
201 # everysec: fsync only if one second passed since the last fsync. Compromise.
202 #
6766f45 Salvatore Sanfilippo multi bulk requests in redis-benchmark, default fsync policy changed to ...
antirez authored
203 # The default is "everysec" that's usually the right compromise between
204 # speed and data safety. It's up to you to understand if you can relax this to
205 # "no" that will will let the operating system flush the output buffer when
206 # it wants, for better performances (but if you can live with the idea of
207 # some data loss consider the default persistence mode that's snapshotting),
208 # or on the contrary, use "always" that's very slow but a bit safer than
209 # everysec.
210 #
211 # If unsure, use "everysec".
212
213 # appendfsync always
214 appendfsync everysec
4e141d5 Salvatore Sanfilippo append only mode is now able to translate EXPIRE into EXPIREAT transpare...
antirez authored
215 # appendfsync no
48f0308 Salvatore Sanfilippo support for appendonly mode no, always, everysec
antirez authored
216
d5d23da Salvatore Sanfilippo redis.conf new features the new option, a minor typo preventing the comp...
antirez authored
217 # When the AOF fsync policy is set to always or everysec, and a background
218 # saving process (a background save or AOF log background rewriting) is
219 # performing a lot of I/O against the disk, in some Linux configurations
220 # Redis may block too long on the fsync() call. Note that there is no fix for
221 # this currently, as even performing fsync in a different thread will block
222 # our synchronous write(2) call.
223 #
224 # In order to mitigate this problem it's possible to use the following option
225 # that will prevent fsync() from being called in the main process while a
226 # BGSAVE or BGREWRITEAOF is in progress.
227 #
228 # This means that while another child is saving the durability of Redis is
229 # the same as "appendfsync none", that in pratical terms means that it is
230 # possible to lost up to 30 seconds of log in the worst scenario (with the
231 # default Linux settings).
232 #
233 # If you have latency problems turn this to "yes". Otherwise leave it as
234 # "no" that is the safest pick from the point of view of durability.
235 no-appendfsync-on-rewrite no
236
a35ddf1 Salvatore Sanfilippo more object-level VM primitives
antirez authored
237 ################################ VIRTUAL MEMORY ###############################
238
4ef8de8 Salvatore Sanfilippo basic VM mostly working!
antirez authored
239 # Virtual Memory allows Redis to work with datasets bigger than the actual
240 # amount of RAM needed to hold the whole dataset in memory.
241 # In order to do so very used keys are taken in memory while the other keys
242 # are swapped into a swap file, similarly to what operating systems do
243 # with memory pages.
244 #
245 # To enable VM just set 'vm-enabled' to yes, and set the following three
246 # VM parameters accordingly to your needs.
c9e5c23 Salvatore Sanfilippo vm-enabled set to no by default in redis.conf
antirez authored
247
248 vm-enabled no
249 # vm-enabled yes
4ef8de8 Salvatore Sanfilippo basic VM mostly working!
antirez authored
250
054e426 Salvatore Sanfilippo support for named VM swap file. Fixed a few important interaction issues...
antirez authored
251 # This is the path of the Redis swap file. As you can guess, swap files
252 # can't be shared by different Redis instances, so make sure to use a swap
a0e7e5f Salvatore Sanfilippo swap file name pid expansion removed. Not suited for mission critical so...
antirez authored
253 # file for every redis process you are running. Redis will complain if the
254 # swap file is already in use.
054e426 Salvatore Sanfilippo support for named VM swap file. Fixed a few important interaction issues...
antirez authored
255 #
a0e7e5f Salvatore Sanfilippo swap file name pid expansion removed. Not suited for mission critical so...
antirez authored
256 # The best kind of storage for the Redis swap file (that's accessed at random)
257 # is a Solid State Disk (SSD).
5921aa3 Salvatore Sanfilippo Bug #169 fixed (BLOP/BRPOP interrupted connections are not cleared from ...
antirez authored
258 #
259 # *** WARNING *** if you are using a shared hosting the default of putting
260 # the swap file under /tmp is not secure. Create a dir with access granted
261 # only to Redis user and configure Redis to create the swap file there.
a0e7e5f Salvatore Sanfilippo swap file name pid expansion removed. Not suited for mission critical so...
antirez authored
262 vm-swap-file /tmp/redis.swap
054e426 Salvatore Sanfilippo support for named VM swap file. Fixed a few important interaction issues...
antirez authored
263
4ef8de8 Salvatore Sanfilippo basic VM mostly working!
antirez authored
264 # vm-max-memory configures the VM to use at max the specified amount of
265 # RAM. Everything that deos not fit will be swapped on disk *if* possible, that
266 # is, if there is still enough contiguous space in the swap file.
38aba9a Salvatore Sanfilippo a new default redis.conf
antirez authored
267 #
ce83302 Salvatore Sanfilippo Saner VM defaults for redis.conf
antirez authored
268 # With vm-max-memory 0 the system will swap everything it can. Not a good
269 # default, just specify the max amount of RAM you can in bytes, but it's
270 # better to leave some margin. For instance specify an amount of RAM
271 # that's more or less between 60 and 80% of your free RAM.
272 vm-max-memory 0
4ef8de8 Salvatore Sanfilippo basic VM mostly working!
antirez authored
273
274 # Redis swap files is split into pages. An object can be saved using multiple
275 # contiguous pages, but pages can't be shared between different objects.
276 # So if your page is too big, small objects swapped out on disk will waste
277 # a lot of space. If you page is too small, there is less space in the swap
278 # file (assuming you configured the same number of total swap file pages).
279 #
280 # If you use a lot of small objects, use a page size of 64 or 32 bytes.
281 # If you use a lot of big objects, use a bigger page size.
92f8e88 Salvatore Sanfilippo non-blocking VM data structures, just a start
antirez authored
282 # If unsure, use the default :)
ce83302 Salvatore Sanfilippo Saner VM defaults for redis.conf
antirez authored
283 vm-page-size 32
4ef8de8 Salvatore Sanfilippo basic VM mostly working!
antirez authored
284
285 # Number of total memory pages in the swap file.
286 # Given that the page table (a bitmap of free/used pages) is taken in memory,
287 # every 8 pages on disk will consume 1 byte of RAM.
288 #
289 # The total swap size is vm-page-size * vm-pages
290 #
ce83302 Salvatore Sanfilippo Saner VM defaults for redis.conf
antirez authored
291 # With the default of 32-bytes memory pages and 134217728 pages Redis will
292 # use a 4 GB swap file, that will use 16 MB of RAM for the page table.
38aba9a Salvatore Sanfilippo a new default redis.conf
antirez authored
293 #
294 # It's better to use the smallest acceptable value for your application,
295 # but the default is large in order to work in most conditions.
ce83302 Salvatore Sanfilippo Saner VM defaults for redis.conf
antirez authored
296 vm-pages 134217728
a35ddf1 Salvatore Sanfilippo more object-level VM primitives
antirez authored
297
92f8e88 Salvatore Sanfilippo non-blocking VM data structures, just a start
antirez authored
298 # Max number of VM I/O threads running at the same time.
299 # This threads are used to read/write data from/to swap file, since they
300 # also encode and decode objects from disk to memory or the reverse, a bigger
301 # number of threads can help with big objects even if they can't help with
302 # I/O itself as the physical device may not be able to couple with many
303 # reads/writes operations at the same time.
72e9fd4 Salvatore Sanfilippo support for blocking VM in config file
antirez authored
304 #
305 # The special value of 0 turn off threaded I/O and enables the blocking
306 # Virtual Memory implementation.
92f8e88 Salvatore Sanfilippo non-blocking VM data structures, just a start
antirez authored
307 vm-max-threads 4
308
ed9b544 Salvatore Sanfilippo first commit
antirez authored
309 ############################### ADVANCED CONFIG ###############################
310
311 # Glue small output buffers together in order to send small replies in a
312 # single TCP packet. Uses a bit more CPU but most of the times it is a win
313 # in terms of number of queries per second. Use 'yes' if unsure.
314 glueoutputbuf yes
10c4361 Salvatore Sanfilippo Nasty bug of the new DB format fixed, objects sharing implemented
antirez authored
315
cbba7dd Salvatore Sanfilippo HSET fixes, now the new pointer is stored back in the object pointer fie...
antirez authored
316 # Hashes are encoded in a special way (much more memory efficient) when they
317 # have at max a given numer of elements, and the biggest element does not
318 # exceed a given threshold. You can configure this limits with the following
319 # configuration directives.
320 hash-max-zipmap-entries 64
321 hash-max-zipmap-value 512
b3f83f1 Jeremy Zawodny support for include directive in config parser
jzawodn authored
322
8ca3e9d Salvatore Sanfilippo Active rehashing
antirez authored
323 # Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
324 # order to help rehashing the main Redis hash table (the one mapping top-level
325 # keys to values). The hash table implementation redis uses (see dict.c)
326 # performs a lazy rehashing: the more operation you run into an hash table
327 # that is rhashing, the more rehashing "steps" are performed, so if the
328 # server is idle the rehashing is never complete and some more memory is used
329 # by the hash table.
330 #
331 # The default is to use this millisecond 10 times every second in order to
332 # active rehashing the main dictionaries, freeing memory when possible.
333 #
334 # If unsure:
335 # use "activerehashing no" if you have hard latency requirements and it is
336 # not a good thing in your environment that Redis can reply form time to time
337 # to queries with 2 milliseconds delay.
338 #
339 # use "activerehashing yes" if you don't have such hard requirements but
340 # want to free memory asap when possible.
341 activerehashing yes
342
b3f83f1 Jeremy Zawodny support for include directive in config parser
jzawodn authored
343 ################################## INCLUDES ###################################
344
345 # Include one or more other config files here. This is useful if you
346 # have a standard template that goes to all redis server but also need
347 # to customize a few per-server settings. Include files can include
348 # other files, so use this wisely.
349 #
350 # include /path/to/local.conf
351 # include /path/to/other.conf
Something went wrong with that request. Please try again.