Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 306 lines (264 sloc) 13.058 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
ed329fc @lucsky Allow to specify the pid file from the config file.
lucsky authored
19 # When run as a daemon, Redis write a pid file in /var/run/redis.pid by default.
20 # You can specify a custom pid file location here.
21 pidfile /var/run/redis.pid
22
ed9b544 @antirez first commit
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
27 # specified all the interfaces will listen for connections.
28 #
29 # bind 127.0.0.1
30
0150db3 @tmm1 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 @antirez first commit
authored
32 timeout 300
33
121f70c @antirez lzf compression switched off by default now, with config file option to ...
authored
34 # Set server verbosity to 'debug'
35 # it can be one of:
36 # debug (a lot of information, useful for development/testing)
38aba9a @antirez a new default redis.conf
authored
37 # 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 to ...
authored
38 # notice (moderately verbose, what you want in production probably)
39 # warning (only very important / critical messages are logged)
38aba9a @antirez a new default redis.conf
authored
40 loglevel verbose
121f70c @antirez lzf compression switched off by default now, with config file option to ...
authored
41
42 # Specify the log file name. Also 'stdout' can be used to force
43 # the demon 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
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 @antirez first commit
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 @antirez BGREWRITEAOF now works with swapping on
authored
65 #
66 # Note: you can disable saving at all commenting all the "save" lines.
67
38aba9a @antirez a new default redis.conf
authored
68 save 900 1
69 save 300 10
70 save 60 10000
ed9b544 @antirez first commit
authored
71
121f70c @antirez lzf compression switched off by default now, with config file option to ...
authored
72 # 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 av...
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 @antirez lzf compression switched off by default now, with config file option to ...
authored
77
b8b553c @antirez ability to specify a different file name for the DB
authored
78 # The filename where to dump the DB
79 dbfilename dump.rdb
80
ed9b544 @antirez first commit
authored
81 # For default save/load DB in/from the working directory
82 # Note that you must specify a directory not a file name.
83 dir ./
84
85 ################################# REPLICATION #################################
86
87 # Master-Slave replication. Use slaveof to make a Redis instance a copy of
88 # another Redis server. Note that the configuration is local to the slave
89 # so for example it is possible to configure the slave to save the DB with a
90 # 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 stone ;...
authored
91 #
ed9b544 @antirez first commit
authored
92 # slaveof <masterip> <masterport>
93
3f47797 @antirez TODO list modified. What's planned for 1.4 is now written in the stone ;...
authored
94 # If the master is password protected (using the "requirepass" configuration
95 # directive below) it is possible to tell the slave to authenticate before
96 # starting the replication synchronization process, otherwise the master will
97 # refuse the slave request.
98 #
99 # masterauth <master-password>
100
f2aa84b @antirez Lua client added thanks to Daniele Alessandri
authored
101 ################################## SECURITY ###################################
102
103 # Require clients to issue AUTH <PASSWORD> before processing any other
104 # commands. This might be useful in environments in which you do not trust
105 # others with access to the host running redis-server.
106 #
107 # This should stay commented out for backward compatibility and because most
108 # people do not need auth (e.g. they run their own servers).
3f47797 @antirez TODO list modified. What's planned for 1.4 is now written in the stone ;...
authored
109 #
290deb8 @antirez TODO changes, minor change to default redis.conf
authored
110 # requirepass foobared
f2aa84b @antirez Lua client added thanks to Daniele Alessandri
authored
111
285add5 @antirez maxclients implemented, see redis.conf for details
authored
112 ################################### LIMITS ####################################
113
114 # Set the max number of connected clients at the same time. By default there
115 # 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
116 # is able to open. The special value '0' means no limits.
285add5 @antirez maxclients implemented, see redis.conf for details
authored
117 # Once the limit is reached Redis will close all the new connections sending
118 # an error 'max number of clients reached'.
3f47797 @antirez TODO list modified. What's planned for 1.4 is now written in the stone ;...
authored
119 #
285add5 @antirez maxclients implemented, see redis.conf for details
authored
120 # maxclients 128
121
3fd78bc @antirez maxmemory implemented
authored
122 # Don't use more memory than the specified amount of bytes.
123 # When the memory limit is reached Redis will try to remove keys with an
124 # EXPIRE set. It will try to start freeing keys that are going to expire
125 # in little time and preserve keys with a longer time to live.
126 # Redis will also try to remove objects from free lists if possible.
127 #
128 # If all this fails, Redis will start to reply with errors to commands
129 # that will use more memory, like SET, LPUSH, and so on, and will continue
130 # to reply to most read-only commands like GET.
144d479 @antirez minor fix for Solaris boxes
authored
131 #
132 # WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
133 # 'state' server or cache, not as a real DB. When Redis is used as a real
134 # database the memory usage will grow over the weeks, it will be obvious if
135 # it is going to use too much memory in the long run, and you'll have the time
136 # to upgrade. With maxmemory after the limit is reached you'll start to get
137 # 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 stone ;...
authored
138 #
3fd78bc @antirez maxmemory implemented
authored
139 # maxmemory <bytes>
140
44b38ef @antirez Initial implementation of append-only mode. Loading still not implemente...
authored
141 ############################## APPEND ONLY MODE ###############################
142
143 # By default Redis asynchronously dumps the dataset on disk. If you can live
144 # with the idea that the latest records will be lost if something like a crash
145 # happens this is the preferred way to run Redis. If instead you care a lot
146 # about your data and don't want to that a single record can get lost you should
147 # enable the append only mode: when this mode is enabled Redis will append
4005fef @antirez Now PUBLISH commands are replicated to slaves
authored
148 # every write operation received in the file appendonly.aof. This file will
44b38ef @antirez Initial implementation of append-only mode. Loading still not implemente...
authored
149 # be read on startup in order to rebuild the full dataset in memory.
150 #
151 # Note that you can have both the async dumps and the append only file if you
152 # like (you have to comment the "save" statements above to disable the dumps).
153 # Still if append only mode is enabled Redis will load the data from the
154 # log file at startup ignoring the dump.rdb file.
0154acd @antirez appendfsync is now set to NO by default
authored
155 #
4005fef @antirez Now PUBLISH commands are replicated to slaves
authored
156 # The name of the append only file is "appendonly.aof"
49b99ab @antirez Changed the reply of BGSAVE and BGREWRITEAOF from +OK to a more meaningf...
authored
157 #
158 # IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
159 # log file in background when it gets too big.
44b38ef @antirez Initial implementation of append-only mode. Loading still not implemente...
authored
160
4e141d5 @antirez append only mode is now able to translate EXPIRE into EXPIREAT transpare...
authored
161 appendonly no
44b38ef @antirez Initial implementation of append-only mode. Loading still not implemente...
authored
162
4e141d5 @antirez append only mode is now able to translate EXPIRE into EXPIREAT transpare...
authored
163 # The fsync() call tells the Operating System to actually write data on disk
48f0308 @antirez support for appendonly mode no, always, everysec
authored
164 # instead to wait for more data in the output buffer. Some OS will really flush
165 # data on disk, some other OS will just try to do it ASAP.
166 #
167 # Redis supports three different modes:
168 #
169 # no: don't fsync, just let the OS flush the data when it wants. Faster.
170 # always: fsync after every write to the append only log . Slow, Safest.
171 # everysec: fsync only if one second passed since the last fsync. Compromise.
172 #
6766f45 @antirez multi bulk requests in redis-benchmark, default fsync policy changed to ...
authored
173 # The default is "everysec" that's usually the right compromise between
174 # speed and data safety. It's up to you to understand if you can relax this to
175 # "no" that will will let the operating system flush the output buffer when
176 # it wants, for better performances (but if you can live with the idea of
177 # some data loss consider the default persistence mode that's snapshotting),
178 # or on the contrary, use "always" that's very slow but a bit safer than
179 # everysec.
180 #
181 # If unsure, use "everysec".
182
183 # appendfsync always
184 appendfsync everysec
4e141d5 @antirez append only mode is now able to translate EXPIRE into EXPIREAT transpare...
authored
185 # appendfsync no
48f0308 @antirez support for appendonly mode no, always, everysec
authored
186
a35ddf1 @antirez more object-level VM primitives
authored
187 ################################ VIRTUAL MEMORY ###############################
188
4ef8de8 @antirez basic VM mostly working!
authored
189 # Virtual Memory allows Redis to work with datasets bigger than the actual
190 # amount of RAM needed to hold the whole dataset in memory.
191 # In order to do so very used keys are taken in memory while the other keys
192 # are swapped into a swap file, similarly to what operating systems do
193 # with memory pages.
194 #
195 # To enable VM just set 'vm-enabled' to yes, and set the following three
196 # VM parameters accordingly to your needs.
c9e5c23 @antirez vm-enabled set to no by default in redis.conf
authored
197
198 vm-enabled no
199 # vm-enabled yes
4ef8de8 @antirez basic VM mostly working!
authored
200
054e426 @antirez support for named VM swap file. Fixed a few important interaction issues...
authored
201 # This is the path of the Redis swap file. As you can guess, swap files
202 # can't be shared by different Redis instances, so make sure to use a swap
203 # file for every redis process you are running.
204 #
205 # The swap file name may contain "%p" that is substituted with the PID of
206 # the Redis process, so the default name /tmp/redis-%p.vm will work even
207 # with multiple instances as Redis will use, for example, redis-811.vm
208 # for one instance and redis-593.vm for another one.
209 #
210 # Useless to say, the best kind of disk for a Redis swap file (that's accessed
211 # at random) is a Solid State Disk (SSD).
5921aa3 @antirez Bug #169 fixed (BLOP/BRPOP interrupted connections are not cleared from ...
authored
212 #
213 # *** WARNING *** if you are using a shared hosting the default of putting
214 # the swap file under /tmp is not secure. Create a dir with access granted
215 # only to Redis user and configure Redis to create the swap file there.
054e426 @antirez support for named VM swap file. Fixed a few important interaction issues...
authored
216 vm-swap-file /tmp/redis-%p.vm
217
4ef8de8 @antirez basic VM mostly working!
authored
218 # vm-max-memory configures the VM to use at max the specified amount of
219 # RAM. Everything that deos not fit will be swapped on disk *if* possible, that
220 # is, if there is still enough contiguous space in the swap file.
38aba9a @antirez a new default redis.conf
authored
221 #
ce83302 @antirez Saner VM defaults for redis.conf
authored
222 # With vm-max-memory 0 the system will swap everything it can. Not a good
223 # default, just specify the max amount of RAM you can in bytes, but it's
224 # better to leave some margin. For instance specify an amount of RAM
225 # that's more or less between 60 and 80% of your free RAM.
226 vm-max-memory 0
4ef8de8 @antirez basic VM mostly working!
authored
227
228 # Redis swap files is split into pages. An object can be saved using multiple
229 # contiguous pages, but pages can't be shared between different objects.
230 # So if your page is too big, small objects swapped out on disk will waste
231 # a lot of space. If you page is too small, there is less space in the swap
232 # file (assuming you configured the same number of total swap file pages).
233 #
234 # If you use a lot of small objects, use a page size of 64 or 32 bytes.
235 # If you use a lot of big objects, use a bigger page size.
92f8e88 @antirez non-blocking VM data structures, just a start
authored
236 # If unsure, use the default :)
ce83302 @antirez Saner VM defaults for redis.conf
authored
237 vm-page-size 32
4ef8de8 @antirez basic VM mostly working!
authored
238
239 # Number of total memory pages in the swap file.
240 # Given that the page table (a bitmap of free/used pages) is taken in memory,
241 # every 8 pages on disk will consume 1 byte of RAM.
242 #
243 # The total swap size is vm-page-size * vm-pages
244 #
ce83302 @antirez Saner VM defaults for redis.conf
authored
245 # With the default of 32-bytes memory pages and 134217728 pages Redis will
246 # 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
247 #
248 # It's better to use the smallest acceptable value for your application,
249 # but the default is large in order to work in most conditions.
ce83302 @antirez Saner VM defaults for redis.conf
authored
250 vm-pages 134217728
a35ddf1 @antirez more object-level VM primitives
authored
251
92f8e88 @antirez non-blocking VM data structures, just a start
authored
252 # Max number of VM I/O threads running at the same time.
253 # This threads are used to read/write data from/to swap file, since they
254 # also encode and decode objects from disk to memory or the reverse, a bigger
255 # number of threads can help with big objects even if they can't help with
256 # I/O itself as the physical device may not be able to couple with many
257 # reads/writes operations at the same time.
72e9fd4 @antirez support for blocking VM in config file
authored
258 #
259 # The special value of 0 turn off threaded I/O and enables the blocking
260 # Virtual Memory implementation.
92f8e88 @antirez non-blocking VM data structures, just a start
authored
261 vm-max-threads 4
262
ed9b544 @antirez first commit
authored
263 ############################### ADVANCED CONFIG ###############################
264
265 # Glue small output buffers together in order to send small replies in a
266 # single TCP packet. Uses a bit more CPU but most of the times it is a win
267 # in terms of number of queries per second. Use 'yes' if unsure.
268 glueoutputbuf yes
10c4361 @antirez Nasty bug of the new DB format fixed, objects sharing implemented
authored
269
cbba7dd @antirez HSET fixes, now the new pointer is stored back in the object pointer fie...
authored
270 # Hashes are encoded in a special way (much more memory efficient) when they
271 # have at max a given numer of elements, and the biggest element does not
272 # exceed a given threshold. You can configure this limits with the following
273 # configuration directives.
274 hash-max-zipmap-entries 64
275 hash-max-zipmap-value 512
b3f83f1 @jzawodn support for include directive in config parser
jzawodn authored
276
8ca3e9d @antirez Active rehashing
authored
277 # Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
278 # order to help rehashing the main Redis hash table (the one mapping top-level
279 # keys to values). The hash table implementation redis uses (see dict.c)
280 # performs a lazy rehashing: the more operation you run into an hash table
281 # that is rhashing, the more rehashing "steps" are performed, so if the
282 # server is idle the rehashing is never complete and some more memory is used
283 # by the hash table.
284 #
285 # The default is to use this millisecond 10 times every second in order to
286 # active rehashing the main dictionaries, freeing memory when possible.
287 #
288 # If unsure:
289 # use "activerehashing no" if you have hard latency requirements and it is
290 # not a good thing in your environment that Redis can reply form time to time
291 # to queries with 2 milliseconds delay.
292 #
293 # use "activerehashing yes" if you don't have such hard requirements but
294 # want to free memory asap when possible.
295 activerehashing yes
296
b3f83f1 @jzawodn support for include directive in config parser
jzawodn authored
297 ################################## INCLUDES ###################################
298
299 # Include one or more other config files here. This is useful if you
300 # have a standard template that goes to all redis server but also need
301 # to customize a few per-server settings. Include files can include
302 # other files, so use this wisely.
303 #
304 # include /path/to/local.conf
305 # include /path/to/other.conf
Something went wrong with that request. Please try again.