]>
Commit | Line | Data |
---|---|---|
ed9b544e | 1 | # Redis configuration file example |
2 | ||
72324005 | 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 | ||
ed9b544e | 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 | ||
029245fe | 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. | |
ed329fcf LH |
21 | pidfile /var/run/redis.pid |
22 | ||
a5639e7d PN |
23 | # Accept connections on the specified port, default is 6379. |
24 | # Use port -1 to disable listening on a network interface. | |
ed9b544e | 25 | port 6379 |
26 | ||
27 | # If you want you can bind a single interface, if the bind option is not | |
029245fe | 28 | # specified all the interfaces will listen for incoming connections. |
ed9b544e | 29 | # |
30 | # bind 127.0.0.1 | |
31 | ||
a5639e7d PN |
32 | # Specify the path for the domain socket that will be used to listen for |
33 | # incoming connections. If not specified, Redis will not use a domain socket. | |
34 | # | |
35 | # socket /tmp/redis.sock | |
36 | ||
0150db36 | 37 | # Close the connection after a client is idle for N seconds (0 to disable) |
ed9b544e | 38 | timeout 300 |
39 | ||
121f70cf | 40 | # Set server verbosity to 'debug' |
41 | # it can be one of: | |
42 | # debug (a lot of information, useful for development/testing) | |
38aba9a1 | 43 | # verbose (many rarely useful info, but not a mess like the debug level) |
121f70cf | 44 | # notice (moderately verbose, what you want in production probably) |
45 | # warning (only very important / critical messages are logged) | |
38aba9a1 | 46 | loglevel verbose |
121f70cf | 47 | |
48 | # Specify the log file name. Also 'stdout' can be used to force | |
029245fe | 49 | # Redis to log on the standard output. Note that if you use standard |
121f70cf | 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 | # | |
ed9b544e | 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 | |
e7546c63 | 71 | # |
72 | # Note: you can disable saving at all commenting all the "save" lines. | |
73 | ||
38aba9a1 | 74 | save 900 1 |
75 | save 300 10 | |
76 | save 60 10000 | |
ed9b544e | 77 | |
121f70cf | 78 | # Compress string objects using LZF when dump .rdb databases? |
b0553789 | 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 | |
121f70cf | 83 | |
b8b553c8 | 84 | # The filename where to dump the DB |
85 | dbfilename dump.rdb | |
86 | ||
029245fe | 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. | |
ed9b544e | 95 | dir ./ |
96 | ||
ed9b544e | 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. | |
3f477979 | 103 | # |
ed9b544e | 104 | # slaveof <masterip> <masterport> |
105 | ||
3f477979 | 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 | ||
f2aa84bd | 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). | |
1b677732 | 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. | |
3f477979 | 125 | # |
290deb8b | 126 | # requirepass foobared |
f2aa84bd | 127 | |
285add55 | 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 | |
92f8e882 | 132 | # is able to open. The special value '0' means no limits. |
285add55 | 133 | # Once the limit is reached Redis will close all the new connections sending |
134 | # an error 'max number of clients reached'. | |
3f477979 | 135 | # |
285add55 | 136 | # maxclients 128 |
137 | ||
3fd78bcd | 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. | |
144d479b | 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. | |
3f477979 | 154 | # |
3fd78bcd | 155 | # maxmemory <bytes> |
156 | ||
44b38ef4 | 157 | ############################## APPEND ONLY MODE ############################### |
158 | ||
159 | # By default Redis asynchronously dumps the dataset on disk. If you can live | |
160 | # with the idea that the latest records will be lost if something like a crash | |
161 | # happens this is the preferred way to run Redis. If instead you care a lot | |
162 | # about your data and don't want to that a single record can get lost you should | |
163 | # enable the append only mode: when this mode is enabled Redis will append | |
4005fef1 | 164 | # every write operation received in the file appendonly.aof. This file will |
44b38ef4 | 165 | # be read on startup in order to rebuild the full dataset in memory. |
166 | # | |
167 | # Note that you can have both the async dumps and the append only file if you | |
168 | # like (you have to comment the "save" statements above to disable the dumps). | |
169 | # Still if append only mode is enabled Redis will load the data from the | |
170 | # log file at startup ignoring the dump.rdb file. | |
0154acdc | 171 | # |
49b99ab4 | 172 | # IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append |
173 | # log file in background when it gets too big. | |
44b38ef4 | 174 | |
4e141d5a | 175 | appendonly no |
44b38ef4 | 176 | |
f3b52411 PN |
177 | # The name of the append only file (default: "appendonly.aof") |
178 | # appendfilename appendonly.aof | |
179 | ||
4e141d5a | 180 | # The fsync() call tells the Operating System to actually write data on disk |
48f0308a | 181 | # instead to wait for more data in the output buffer. Some OS will really flush |
182 | # data on disk, some other OS will just try to do it ASAP. | |
183 | # | |
184 | # Redis supports three different modes: | |
185 | # | |
186 | # no: don't fsync, just let the OS flush the data when it wants. Faster. | |
187 | # always: fsync after every write to the append only log . Slow, Safest. | |
188 | # everysec: fsync only if one second passed since the last fsync. Compromise. | |
189 | # | |
6766f45e | 190 | # The default is "everysec" that's usually the right compromise between |
191 | # speed and data safety. It's up to you to understand if you can relax this to | |
192 | # "no" that will will let the operating system flush the output buffer when | |
193 | # it wants, for better performances (but if you can live with the idea of | |
194 | # some data loss consider the default persistence mode that's snapshotting), | |
195 | # or on the contrary, use "always" that's very slow but a bit safer than | |
196 | # everysec. | |
197 | # | |
198 | # If unsure, use "everysec". | |
199 | ||
200 | # appendfsync always | |
201 | appendfsync everysec | |
4e141d5a | 202 | # appendfsync no |
48f0308a | 203 | |
d5d23dab | 204 | # When the AOF fsync policy is set to always or everysec, and a background |
205 | # saving process (a background save or AOF log background rewriting) is | |
206 | # performing a lot of I/O against the disk, in some Linux configurations | |
207 | # Redis may block too long on the fsync() call. Note that there is no fix for | |
208 | # this currently, as even performing fsync in a different thread will block | |
209 | # our synchronous write(2) call. | |
210 | # | |
211 | # In order to mitigate this problem it's possible to use the following option | |
212 | # that will prevent fsync() from being called in the main process while a | |
213 | # BGSAVE or BGREWRITEAOF is in progress. | |
214 | # | |
215 | # This means that while another child is saving the durability of Redis is | |
216 | # the same as "appendfsync none", that in pratical terms means that it is | |
217 | # possible to lost up to 30 seconds of log in the worst scenario (with the | |
218 | # default Linux settings). | |
219 | # | |
220 | # If you have latency problems turn this to "yes". Otherwise leave it as | |
221 | # "no" that is the safest pick from the point of view of durability. | |
222 | no-appendfsync-on-rewrite no | |
223 | ||
a35ddf12 | 224 | ################################ VIRTUAL MEMORY ############################### |
225 | ||
4ef8de8a | 226 | # Virtual Memory allows Redis to work with datasets bigger than the actual |
227 | # amount of RAM needed to hold the whole dataset in memory. | |
228 | # In order to do so very used keys are taken in memory while the other keys | |
229 | # are swapped into a swap file, similarly to what operating systems do | |
230 | # with memory pages. | |
231 | # | |
232 | # To enable VM just set 'vm-enabled' to yes, and set the following three | |
233 | # VM parameters accordingly to your needs. | |
c9e5c23d | 234 | |
235 | vm-enabled no | |
236 | # vm-enabled yes | |
4ef8de8a | 237 | |
054e426d | 238 | # This is the path of the Redis swap file. As you can guess, swap files |
239 | # can't be shared by different Redis instances, so make sure to use a swap | |
a0e7e5f5 | 240 | # file for every redis process you are running. Redis will complain if the |
241 | # swap file is already in use. | |
054e426d | 242 | # |
a0e7e5f5 | 243 | # The best kind of storage for the Redis swap file (that's accessed at random) |
244 | # is a Solid State Disk (SSD). | |
5921aa36 | 245 | # |
246 | # *** WARNING *** if you are using a shared hosting the default of putting | |
247 | # the swap file under /tmp is not secure. Create a dir with access granted | |
248 | # only to Redis user and configure Redis to create the swap file there. | |
a0e7e5f5 | 249 | vm-swap-file /tmp/redis.swap |
054e426d | 250 | |
4ef8de8a | 251 | # vm-max-memory configures the VM to use at max the specified amount of |
252 | # RAM. Everything that deos not fit will be swapped on disk *if* possible, that | |
253 | # is, if there is still enough contiguous space in the swap file. | |
38aba9a1 | 254 | # |
ce833020 | 255 | # With vm-max-memory 0 the system will swap everything it can. Not a good |
256 | # default, just specify the max amount of RAM you can in bytes, but it's | |
257 | # better to leave some margin. For instance specify an amount of RAM | |
258 | # that's more or less between 60 and 80% of your free RAM. | |
259 | vm-max-memory 0 | |
4ef8de8a | 260 | |
261 | # Redis swap files is split into pages. An object can be saved using multiple | |
262 | # contiguous pages, but pages can't be shared between different objects. | |
263 | # So if your page is too big, small objects swapped out on disk will waste | |
264 | # a lot of space. If you page is too small, there is less space in the swap | |
265 | # file (assuming you configured the same number of total swap file pages). | |
266 | # | |
267 | # If you use a lot of small objects, use a page size of 64 or 32 bytes. | |
268 | # If you use a lot of big objects, use a bigger page size. | |
92f8e882 | 269 | # If unsure, use the default :) |
ce833020 | 270 | vm-page-size 32 |
4ef8de8a | 271 | |
272 | # Number of total memory pages in the swap file. | |
273 | # Given that the page table (a bitmap of free/used pages) is taken in memory, | |
274 | # every 8 pages on disk will consume 1 byte of RAM. | |
275 | # | |
276 | # The total swap size is vm-page-size * vm-pages | |
277 | # | |
ce833020 | 278 | # With the default of 32-bytes memory pages and 134217728 pages Redis will |
279 | # use a 4 GB swap file, that will use 16 MB of RAM for the page table. | |
38aba9a1 | 280 | # |
281 | # It's better to use the smallest acceptable value for your application, | |
282 | # but the default is large in order to work in most conditions. | |
ce833020 | 283 | vm-pages 134217728 |
a35ddf12 | 284 | |
92f8e882 | 285 | # Max number of VM I/O threads running at the same time. |
286 | # This threads are used to read/write data from/to swap file, since they | |
287 | # also encode and decode objects from disk to memory or the reverse, a bigger | |
288 | # number of threads can help with big objects even if they can't help with | |
289 | # I/O itself as the physical device may not be able to couple with many | |
290 | # reads/writes operations at the same time. | |
72e9fd40 | 291 | # |
292 | # The special value of 0 turn off threaded I/O and enables the blocking | |
293 | # Virtual Memory implementation. | |
92f8e882 | 294 | vm-max-threads 4 |
295 | ||
ed9b544e | 296 | ############################### ADVANCED CONFIG ############################### |
297 | ||
298 | # Glue small output buffers together in order to send small replies in a | |
299 | # single TCP packet. Uses a bit more CPU but most of the times it is a win | |
300 | # in terms of number of queries per second. Use 'yes' if unsure. | |
301 | glueoutputbuf yes | |
10c43610 | 302 | |
cbba7dd7 | 303 | # Hashes are encoded in a special way (much more memory efficient) when they |
304 | # have at max a given numer of elements, and the biggest element does not | |
305 | # exceed a given threshold. You can configure this limits with the following | |
306 | # configuration directives. | |
307 | hash-max-zipmap-entries 64 | |
308 | hash-max-zipmap-value 512 | |
b3f83f12 | 309 | |
8ca3e9d1 | 310 | # Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in |
311 | # order to help rehashing the main Redis hash table (the one mapping top-level | |
312 | # keys to values). The hash table implementation redis uses (see dict.c) | |
313 | # performs a lazy rehashing: the more operation you run into an hash table | |
314 | # that is rhashing, the more rehashing "steps" are performed, so if the | |
315 | # server is idle the rehashing is never complete and some more memory is used | |
316 | # by the hash table. | |
317 | # | |
318 | # The default is to use this millisecond 10 times every second in order to | |
319 | # active rehashing the main dictionaries, freeing memory when possible. | |
320 | # | |
321 | # If unsure: | |
322 | # use "activerehashing no" if you have hard latency requirements and it is | |
323 | # not a good thing in your environment that Redis can reply form time to time | |
324 | # to queries with 2 milliseconds delay. | |
325 | # | |
326 | # use "activerehashing yes" if you don't have such hard requirements but | |
327 | # want to free memory asap when possible. | |
328 | activerehashing yes | |
329 | ||
b3f83f12 JZ |
330 | ################################## INCLUDES ################################### |
331 | ||
332 | # Include one or more other config files here. This is useful if you | |
333 | # have a standard template that goes to all redis server but also need | |
334 | # to customize a few per-server settings. Include files can include | |
335 | # other files, so use this wisely. | |
336 | # | |
337 | # include /path/to/local.conf | |
338 | # include /path/to/other.conf |