Skip to content

HTTPS clone URL

Subversion checkout URL

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