]> git.saurik.com Git - redis.git/blob - redis.conf
Merge remote branch 'pietern/unixsocket'
[redis.git] / redis.conf
1 # Redis configuration file example
2
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
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
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
22
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 incoming connections.
28 #
29 # bind 127.0.0.1
30
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.
34 #
35 # unixsocket /tmp/redis.sock
36
37 # Close the connection after a client is idle for N seconds (0 to disable)
38 timeout 300
39
40 # Set server verbosity to 'debug'
41 # it can be one of:
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)
46 loglevel verbose
47
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
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 #
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
71 #
72 # Note: you can disable saving at all commenting all the "save" lines.
73
74 save 900 1
75 save 300 10
76 save 60 10000
77
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.
82 rdbcompression yes
83
84 # The filename where to dump the DB
85 dbfilename dump.rdb
86
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.
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.
103 #
104 # slaveof <masterip> <masterport>
105
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
113 ################################## SECURITY ###################################
114
115 # Require clients to issue AUTH <PASSWORD> before processing any other
116 # commands. This might be useful in environments in which you do not trust
117 # others with access to the host running redis-server.
118 #
119 # This should stay commented out for backward compatibility and because most
120 # people do not need auth (e.g. they run their own servers).
121 #
122 # Warning: since Redis is pretty fast an outside user can try up to
123 # 150k passwords per second against a good box. This means that you should
124 # use a very strong password otherwise it will be very easy to break.
125 #
126 # requirepass foobared
127
128 ################################### LIMITS ####################################
129
130 # Set the max number of connected clients at the same time. By default there
131 # is no limit, and it's up to the number of file descriptors the Redis process
132 # is able to open. The special value '0' means no limits.
133 # Once the limit is reached Redis will close all the new connections sending
134 # an error 'max number of clients reached'.
135 #
136 # maxclients 128
137
138 # Don't use more memory than the specified amount of bytes.
139 # When the memory limit is reached Redis will try to remove keys with an
140 # EXPIRE set. It will try to start freeing keys that are going to expire
141 # in little time and preserve keys with a longer time to live.
142 # Redis will also try to remove objects from free lists if possible.
143 #
144 # If all this fails, Redis will start to reply with errors to commands
145 # that will use more memory, like SET, LPUSH, and so on, and will continue
146 # to reply to most read-only commands like GET.
147 #
148 # WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
149 # 'state' server or cache, not as a real DB. When Redis is used as a real
150 # database the memory usage will grow over the weeks, it will be obvious if
151 # it is going to use too much memory in the long run, and you'll have the time
152 # to upgrade. With maxmemory after the limit is reached you'll start to get
153 # errors for write operations, and this may even lead to DB inconsistency.
154 #
155 # maxmemory <bytes>
156
157 # MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
158 # is reached? You can select among five behavior:
159 #
160 # volatile-lru -> remove the key with an expire set using an LRU algorithm
161 # allkeys-lru -> remove any key accordingly to the LRU algorithm
162 # volatile-random -> remove a random key with an expire set
163 # allkeys->random -> remove a random key, any key
164 # volatile-ttl -> remove the key with the nearest expire time (minor TTL)
165 #
166 # maxmemory-policy volatile-lru
167
168 # LRU and minimal TTL algorithms are not precise algorithms but approximated
169 # algorithms (in order to save memory), so you can select as well the sample
170 # size to check. For instance for default Redis will check three keys and
171 # pick the one that was used less recently, you can change the sample size
172 # using the following configuration directive.
173 #
174 # maxmemory-samples 3
175
176 ############################## APPEND ONLY MODE ###############################
177
178 # By default Redis asynchronously dumps the dataset on disk. If you can live
179 # with the idea that the latest records will be lost if something like a crash
180 # happens this is the preferred way to run Redis. If instead you care a lot
181 # about your data and don't want to that a single record can get lost you should
182 # enable the append only mode: when this mode is enabled Redis will append
183 # every write operation received in the file appendonly.aof. This file will
184 # be read on startup in order to rebuild the full dataset in memory.
185 #
186 # Note that you can have both the async dumps and the append only file if you
187 # like (you have to comment the "save" statements above to disable the dumps).
188 # Still if append only mode is enabled Redis will load the data from the
189 # log file at startup ignoring the dump.rdb file.
190 #
191 # IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
192 # log file in background when it gets too big.
193
194 appendonly no
195
196 # The name of the append only file (default: "appendonly.aof")
197 # appendfilename appendonly.aof
198
199 # The fsync() call tells the Operating System to actually write data on disk
200 # instead to wait for more data in the output buffer. Some OS will really flush
201 # data on disk, some other OS will just try to do it ASAP.
202 #
203 # Redis supports three different modes:
204 #
205 # no: don't fsync, just let the OS flush the data when it wants. Faster.
206 # always: fsync after every write to the append only log . Slow, Safest.
207 # everysec: fsync only if one second passed since the last fsync. Compromise.
208 #
209 # The default is "everysec" that's usually the right compromise between
210 # speed and data safety. It's up to you to understand if you can relax this to
211 # "no" that will will let the operating system flush the output buffer when
212 # it wants, for better performances (but if you can live with the idea of
213 # some data loss consider the default persistence mode that's snapshotting),
214 # or on the contrary, use "always" that's very slow but a bit safer than
215 # everysec.
216 #
217 # If unsure, use "everysec".
218
219 # appendfsync always
220 appendfsync everysec
221 # appendfsync no
222
223 # When the AOF fsync policy is set to always or everysec, and a background
224 # saving process (a background save or AOF log background rewriting) is
225 # performing a lot of I/O against the disk, in some Linux configurations
226 # Redis may block too long on the fsync() call. Note that there is no fix for
227 # this currently, as even performing fsync in a different thread will block
228 # our synchronous write(2) call.
229 #
230 # In order to mitigate this problem it's possible to use the following option
231 # that will prevent fsync() from being called in the main process while a
232 # BGSAVE or BGREWRITEAOF is in progress.
233 #
234 # This means that while another child is saving the durability of Redis is
235 # the same as "appendfsync none", that in pratical terms means that it is
236 # possible to lost up to 30 seconds of log in the worst scenario (with the
237 # default Linux settings).
238 #
239 # If you have latency problems turn this to "yes". Otherwise leave it as
240 # "no" that is the safest pick from the point of view of durability.
241 no-appendfsync-on-rewrite no
242
243 ################################ VIRTUAL MEMORY ###############################
244
245 # Virtual Memory allows Redis to work with datasets bigger than the actual
246 # amount of RAM needed to hold the whole dataset in memory.
247 # In order to do so very used keys are taken in memory while the other keys
248 # are swapped into a swap file, similarly to what operating systems do
249 # with memory pages.
250 #
251 # To enable VM just set 'vm-enabled' to yes, and set the following three
252 # VM parameters accordingly to your needs.
253
254 vm-enabled no
255 # vm-enabled yes
256
257 # This is the path of the Redis swap file. As you can guess, swap files
258 # can't be shared by different Redis instances, so make sure to use a swap
259 # file for every redis process you are running. Redis will complain if the
260 # swap file is already in use.
261 #
262 # The best kind of storage for the Redis swap file (that's accessed at random)
263 # is a Solid State Disk (SSD).
264 #
265 # *** WARNING *** if you are using a shared hosting the default of putting
266 # the swap file under /tmp is not secure. Create a dir with access granted
267 # only to Redis user and configure Redis to create the swap file there.
268 vm-swap-file /tmp/redis.swap
269
270 # vm-max-memory configures the VM to use at max the specified amount of
271 # RAM. Everything that deos not fit will be swapped on disk *if* possible, that
272 # is, if there is still enough contiguous space in the swap file.
273 #
274 # With vm-max-memory 0 the system will swap everything it can. Not a good
275 # default, just specify the max amount of RAM you can in bytes, but it's
276 # better to leave some margin. For instance specify an amount of RAM
277 # that's more or less between 60 and 80% of your free RAM.
278 vm-max-memory 0
279
280 # Redis swap files is split into pages. An object can be saved using multiple
281 # contiguous pages, but pages can't be shared between different objects.
282 # So if your page is too big, small objects swapped out on disk will waste
283 # a lot of space. If you page is too small, there is less space in the swap
284 # file (assuming you configured the same number of total swap file pages).
285 #
286 # If you use a lot of small objects, use a page size of 64 or 32 bytes.
287 # If you use a lot of big objects, use a bigger page size.
288 # If unsure, use the default :)
289 vm-page-size 32
290
291 # Number of total memory pages in the swap file.
292 # Given that the page table (a bitmap of free/used pages) is taken in memory,
293 # every 8 pages on disk will consume 1 byte of RAM.
294 #
295 # The total swap size is vm-page-size * vm-pages
296 #
297 # With the default of 32-bytes memory pages and 134217728 pages Redis will
298 # use a 4 GB swap file, that will use 16 MB of RAM for the page table.
299 #
300 # It's better to use the smallest acceptable value for your application,
301 # but the default is large in order to work in most conditions.
302 vm-pages 134217728
303
304 # Max number of VM I/O threads running at the same time.
305 # This threads are used to read/write data from/to swap file, since they
306 # also encode and decode objects from disk to memory or the reverse, a bigger
307 # number of threads can help with big objects even if they can't help with
308 # I/O itself as the physical device may not be able to couple with many
309 # reads/writes operations at the same time.
310 #
311 # The special value of 0 turn off threaded I/O and enables the blocking
312 # Virtual Memory implementation.
313 vm-max-threads 4
314
315 ############################### ADVANCED CONFIG ###############################
316
317 # Glue small output buffers together in order to send small replies in a
318 # single TCP packet. Uses a bit more CPU but most of the times it is a win
319 # in terms of number of queries per second. Use 'yes' if unsure.
320 glueoutputbuf yes
321
322 # Hashes are encoded in a special way (much more memory efficient) when they
323 # have at max a given numer of elements, and the biggest element does not
324 # exceed a given threshold. You can configure this limits with the following
325 # configuration directives.
326 hash-max-zipmap-entries 64
327 hash-max-zipmap-value 512
328
329 # Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
330 # order to help rehashing the main Redis hash table (the one mapping top-level
331 # keys to values). The hash table implementation redis uses (see dict.c)
332 # performs a lazy rehashing: the more operation you run into an hash table
333 # that is rhashing, the more rehashing "steps" are performed, so if the
334 # server is idle the rehashing is never complete and some more memory is used
335 # by the hash table.
336 #
337 # The default is to use this millisecond 10 times every second in order to
338 # active rehashing the main dictionaries, freeing memory when possible.
339 #
340 # If unsure:
341 # use "activerehashing no" if you have hard latency requirements and it is
342 # not a good thing in your environment that Redis can reply form time to time
343 # to queries with 2 milliseconds delay.
344 #
345 # use "activerehashing yes" if you don't have such hard requirements but
346 # want to free memory asap when possible.
347 activerehashing yes
348
349 ################################## INCLUDES ###################################
350
351 # Include one or more other config files here. This is useful if you
352 # have a standard template that goes to all redis server but also need
353 # to customize a few per-server settings. Include files can include
354 # other files, so use this wisely.
355 #
356 # include /path/to/local.conf
357 # include /path/to/other.conf