Skip to content
Newer
Older
100644 230 lines (195 sloc) 9.62 KB
ed9b544 @antirez first commit
authored Mar 22, 2009
1 # Redis configuration file example
2
3 # By default Redis does not run as a daemon. Use 'yes' if you need it.
4 # Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
5 daemonize no
6
ed329fc @lucsky Allow to specify the pid file from the config file.
lucsky authored Mar 23, 2009
7 # When run as a daemon, Redis write a pid file in /var/run/redis.pid by default.
8 # You can specify a custom pid file location here.
9 pidfile /var/run/redis.pid
10
ed9b544 @antirez first commit
authored Mar 22, 2009
11 # Accept connections on the specified port, default is 6379
12 port 6379
13
14 # If you want you can bind a single interface, if the bind option is not
15 # specified all the interfaces will listen for connections.
16 #
17 # bind 127.0.0.1
18
0150db3 @tmm1 Allow timeout=0 config to disable client timeouts
tmm1 authored May 19, 2009
19 # Close the connection after a client is idle for N seconds (0 to disable)
ed9b544 @antirez first commit
authored Mar 22, 2009
20 timeout 300
21
121f70c @antirez lzf compression switched off by default now, with config file option …
authored Dec 16, 2009
22 # Set server verbosity to 'debug'
23 # it can be one of:
24 # debug (a lot of information, useful for development/testing)
25 # notice (moderately verbose, what you want in production probably)
26 # warning (only very important / critical messages are logged)
27 loglevel debug
28
29 # Specify the log file name. Also 'stdout' can be used to force
30 # the demon to log on the standard output. Note that if you use standard
31 # output for logging but daemonize, logs will be sent to /dev/null
32 logfile stdout
33
34 # Set the number of databases. The default database is DB 0, you can select
35 # a different one on a per-connection basis using SELECT <dbid> where
36 # dbid is a number between 0 and 'databases'-1
37 databases 16
38
39 ################################ SNAPSHOTTING #################################
40 #
ed9b544 @antirez first commit
authored Mar 22, 2009
41 # Save the DB on disk:
42 #
43 # save <seconds> <changes>
44 #
45 # Will save the DB if both the given number of seconds and the given
46 # number of write operations against the DB occurred.
47 #
48 # In the example below the behaviour will be to save:
49 # after 900 sec (15 min) if at least 1 key changed
50 # after 300 sec (5 min) if at least 10 keys changed
51 # after 60 sec if at least 10000 keys changed
52 save 900 1
53 save 300 10
54 save 60 10000
55
121f70c @antirez lzf compression switched off by default now, with config file option …
authored Dec 16, 2009
56 # 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 Dec 16, 2009
57 # For default that's set to 'yes' as it's almost always a win.
58 # If you want to save some CPU in the saving child set it to 'no' but
59 # the dataset will likely be bigger if you have compressible values or keys.
60 rdbcompression yes
121f70c @antirez lzf compression switched off by default now, with config file option …
authored Dec 16, 2009
61
b8b553c @antirez ability to specify a different file name for the DB
authored Apr 27, 2009
62 # The filename where to dump the DB
63 dbfilename dump.rdb
64
ed9b544 @antirez first commit
authored Mar 22, 2009
65 # For default save/load DB in/from the working directory
66 # Note that you must specify a directory not a file name.
67 dir ./
68
69 ################################# REPLICATION #################################
70
71 # Master-Slave replication. Use slaveof to make a Redis instance a copy of
72 # another Redis server. Note that the configuration is local to the slave
73 # so for example it is possible to configure the slave to save the DB with a
74 # 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 Dec 12, 2009
75 #
ed9b544 @antirez first commit
authored Mar 22, 2009
76 # slaveof <masterip> <masterport>
77
3f47797 @antirez TODO list modified. What's planned for 1.4 is now written in the ston…
authored Dec 12, 2009
78 # If the master is password protected (using the "requirepass" configuration
79 # directive below) it is possible to tell the slave to authenticate before
80 # starting the replication synchronization process, otherwise the master will
81 # refuse the slave request.
82 #
83 # masterauth <master-password>
84
f2aa84b @antirez Lua client added thanks to Daniele Alessandri
authored Mar 26, 2009
85 ################################## SECURITY ###################################
86
87 # Require clients to issue AUTH <PASSWORD> before processing any other
88 # commands. This might be useful in environments in which you do not trust
89 # others with access to the host running redis-server.
90 #
91 # This should stay commented out for backward compatibility and because most
92 # 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 ston…
authored Dec 12, 2009
93 #
290deb8 @antirez TODO changes, minor change to default redis.conf
authored Apr 8, 2009
94 # requirepass foobared
f2aa84b @antirez Lua client added thanks to Daniele Alessandri
authored Mar 26, 2009
95
285add5 @antirez maxclients implemented, see redis.conf for details
authored May 25, 2009
96 ################################### LIMITS ####################################
97
98 # Set the max number of connected clients at the same time. By default there
99 # is no limit, and it's up to the number of file descriptors the Redis process
100 # is able to open. The special value '0' means no limts.
101 # Once the limit is reached Redis will close all the new connections sending
102 # 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 Dec 12, 2009
103 #
285add5 @antirez maxclients implemented, see redis.conf for details
authored May 25, 2009
104 # maxclients 128
105
3fd78bc @antirez maxmemory implemented
authored May 27, 2009
106 # Don't use more memory than the specified amount of bytes.
107 # When the memory limit is reached Redis will try to remove keys with an
108 # EXPIRE set. It will try to start freeing keys that are going to expire
109 # in little time and preserve keys with a longer time to live.
110 # Redis will also try to remove objects from free lists if possible.
111 #
112 # If all this fails, Redis will start to reply with errors to commands
113 # that will use more memory, like SET, LPUSH, and so on, and will continue
114 # to reply to most read-only commands like GET.
144d479 @antirez minor fix for Solaris boxes
authored May 28, 2009
115 #
116 # WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
117 # 'state' server or cache, not as a real DB. When Redis is used as a real
118 # database the memory usage will grow over the weeks, it will be obvious if
119 # it is going to use too much memory in the long run, and you'll have the time
120 # to upgrade. With maxmemory after the limit is reached you'll start to get
121 # 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 Dec 12, 2009
122 #
3fd78bc @antirez maxmemory implemented
authored May 27, 2009
123 # maxmemory <bytes>
124
44b38ef @antirez Initial implementation of append-only mode. Loading still not impleme…
authored Oct 30, 2009
125 ############################## APPEND ONLY MODE ###############################
126
127 # By default Redis asynchronously dumps the dataset on disk. If you can live
128 # with the idea that the latest records will be lost if something like a crash
129 # happens this is the preferred way to run Redis. If instead you care a lot
130 # about your data and don't want to that a single record can get lost you should
131 # enable the append only mode: when this mode is enabled Redis will append
132 # every write operation received in the file appendonly.log. This file will
133 # be read on startup in order to rebuild the full dataset in memory.
134 #
135 # Note that you can have both the async dumps and the append only file if you
136 # like (you have to comment the "save" statements above to disable the dumps).
137 # Still if append only mode is enabled Redis will load the data from the
138 # log file at startup ignoring the dump.rdb file.
0154acd @antirez appendfsync is now set to NO by default
authored Oct 30, 2009
139 #
140 # The name of the append only file is "appendonly.log"
49b99ab @antirez Changed the reply of BGSAVE and BGREWRITEAOF from +OK to a more meani…
authored Dec 13, 2009
141 #
142 # IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
143 # log file in background when it gets too big.
44b38ef @antirez Initial implementation of append-only mode. Loading still not impleme…
authored Oct 30, 2009
144
4e141d5 @antirez append only mode is now able to translate EXPIRE into EXPIREAT transp…
authored Oct 30, 2009
145 appendonly no
44b38ef @antirez Initial implementation of append-only mode. Loading still not impleme…
authored Oct 30, 2009
146
4e141d5 @antirez append only mode is now able to translate EXPIRE into EXPIREAT transp…
authored Oct 30, 2009
147 # The fsync() call tells the Operating System to actually write data on disk
48f0308 @antirez support for appendonly mode no, always, everysec
authored Oct 30, 2009
148 # instead to wait for more data in the output buffer. Some OS will really flush
149 # data on disk, some other OS will just try to do it ASAP.
150 #
151 # Redis supports three different modes:
152 #
153 # no: don't fsync, just let the OS flush the data when it wants. Faster.
154 # always: fsync after every write to the append only log . Slow, Safest.
155 # everysec: fsync only if one second passed since the last fsync. Compromise.
156 #
4e141d5 @antirez append only mode is now able to translate EXPIRE into EXPIREAT transp…
authored Oct 30, 2009
157 # The default is "always" that's the safer of the options. It's up to you to
158 # understand if you can relax this to "everysec" that will fsync every second
159 # or to "no" that will let the operating system flush the output buffer when
160 # it want, for better performances (but if you can live with the idea of
161 # some data loss consider the default persistence mode that's snapshotting).
48f0308 @antirez support for appendonly mode no, always, everysec
authored Oct 30, 2009
162
4e141d5 @antirez append only mode is now able to translate EXPIRE into EXPIREAT transp…
authored Oct 30, 2009
163 appendfsync always
48f0308 @antirez support for appendonly mode no, always, everysec
authored Oct 30, 2009
164 # appendfsync everysec
4e141d5 @antirez append only mode is now able to translate EXPIRE into EXPIREAT transp…
authored Oct 30, 2009
165 # appendfsync no
48f0308 @antirez support for appendonly mode no, always, everysec
authored Oct 30, 2009
166
a35ddf1 @antirez more object-level VM primitives
authored Jan 5, 2010
167 ################################ VIRTUAL MEMORY ###############################
168
4ef8de8 @antirez basic VM mostly working!
authored Jan 5, 2010
169 # Virtual Memory allows Redis to work with datasets bigger than the actual
170 # amount of RAM needed to hold the whole dataset in memory.
171 # In order to do so very used keys are taken in memory while the other keys
172 # are swapped into a swap file, similarly to what operating systems do
173 # with memory pages.
174 #
175 # To enable VM just set 'vm-enabled' to yes, and set the following three
176 # VM parameters accordingly to your needs.
177
a35ddf1 @antirez more object-level VM primitives
authored Jan 5, 2010
178 vm-enabled yes
4ef8de8 @antirez basic VM mostly working!
authored Jan 5, 2010
179 # vm-enabled no
180
181 # vm-max-memory configures the VM to use at max the specified amount of
182 # RAM. Everything that deos not fit will be swapped on disk *if* possible, that
183 # is, if there is still enough contiguous space in the swap file.
184 vm-max-memory 10000000
185
186 # Redis swap files is split into pages. An object can be saved using multiple
187 # contiguous pages, but pages can't be shared between different objects.
188 # So if your page is too big, small objects swapped out on disk will waste
189 # a lot of space. If you page is too small, there is less space in the swap
190 # file (assuming you configured the same number of total swap file pages).
191 #
192 # If you use a lot of small objects, use a page size of 64 or 32 bytes.
193 # If you use a lot of big objects, use a bigger page size.
194 # If unsure, use the defualt :)
195 vm-page-size 256
196
197 # Number of total memory pages in the swap file.
198 # Given that the page table (a bitmap of free/used pages) is taken in memory,
199 # every 8 pages on disk will consume 1 byte of RAM.
200 #
201 # The total swap size is vm-page-size * vm-pages
202 #
203 # With the default of 256-bytes memory pages and 104857600 pages Redis will
204 # use a 25 GB swap file, that will use rougly 13 MB of RAM for the page table.
205 vm-pages 104857600
a35ddf1 @antirez more object-level VM primitives
authored Jan 5, 2010
206
ed9b544 @antirez first commit
authored Mar 22, 2009
207 ############################### ADVANCED CONFIG ###############################
208
209 # Glue small output buffers together in order to send small replies in a
210 # single TCP packet. Uses a bit more CPU but most of the times it is a win
211 # in terms of number of queries per second. Use 'yes' if unsure.
212 glueoutputbuf yes
10c4361 @antirez Nasty bug of the new DB format fixed, objects sharing implemented
authored Mar 25, 2009
213
214 # Use object sharing. Can save a lot of memory if you have many common
215 # string in your dataset, but performs lookups against the shared objects
216 # pool so it uses more CPU and can be a bit slower. Usually it's a good
217 # idea.
e52c65b @antirez shareobjectspoolsize implemented in reds.conf, in order to control th…
authored Jun 3, 2009
218 #
219 # When object sharing is enabled (shareobjects yes) you can use
220 # shareobjectspoolsize to control the size of the pool used in order to try
221 # object sharing. A bigger pool size will lead to better sharing capabilities.
222 # In general you want this value to be at least the double of the number of
223 # very common strings you have in your dataset.
224 #
225 # WARNING: object sharing is experimental, don't enable this feature
226 # in production before of Redis 1.0-stable. Still please try this feature in
227 # your development environment so that we can test it better.
10c4361 @antirez Nasty bug of the new DB format fixed, objects sharing implemented
authored Mar 25, 2009
228 shareobjects no
e52c65b @antirez shareobjectspoolsize implemented in reds.conf, in order to control th…
authored Jun 3, 2009
229 shareobjectspoolsize 1024
Something went wrong with that request. Please try again.