]> git.saurik.com Git - redis.git/blame - redis.conf
Introduced a new log verbosity level, so now DEBUG is really for debugging. Refactore...
[redis.git] / redis.conf
CommitLineData
ed9b544e 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.
5daemonize no
6
ed329fcf
LH
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.
9pidfile /var/run/redis.pid
10
ed9b544e 11# Accept connections on the specified port, default is 6379
12port 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
0150db36 19# Close the connection after a client is idle for N seconds (0 to disable)
ed9b544e 20timeout 300
21
121f70cf 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)
f870935d 27loglevel verbose
121f70cf 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
32logfile 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
37databases 16
38
39################################ SNAPSHOTTING #################################
40#
ed9b544e 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
e7546c63 52#
53# Note: you can disable saving at all commenting all the "save" lines.
54
55#save 900 1
56#save 300 10
57#save 60 10000
ed9b544e 58
121f70cf 59# Compress string objects using LZF when dump .rdb databases?
b0553789 60# For default that's set to 'yes' as it's almost always a win.
61# If you want to save some CPU in the saving child set it to 'no' but
62# the dataset will likely be bigger if you have compressible values or keys.
63rdbcompression yes
121f70cf 64
b8b553c8 65# The filename where to dump the DB
66dbfilename dump.rdb
67
ed9b544e 68# For default save/load DB in/from the working directory
69# Note that you must specify a directory not a file name.
70dir ./
71
ed9b544e 72################################# REPLICATION #################################
73
74# Master-Slave replication. Use slaveof to make a Redis instance a copy of
75# another Redis server. Note that the configuration is local to the slave
76# so for example it is possible to configure the slave to save the DB with a
77# different interval, or to listen to another port, and so on.
3f477979 78#
ed9b544e 79# slaveof <masterip> <masterport>
80
3f477979 81# If the master is password protected (using the "requirepass" configuration
82# directive below) it is possible to tell the slave to authenticate before
83# starting the replication synchronization process, otherwise the master will
84# refuse the slave request.
85#
86# masterauth <master-password>
87
f2aa84bd 88################################## SECURITY ###################################
89
90# Require clients to issue AUTH <PASSWORD> before processing any other
91# commands. This might be useful in environments in which you do not trust
92# others with access to the host running redis-server.
93#
94# This should stay commented out for backward compatibility and because most
95# people do not need auth (e.g. they run their own servers).
3f477979 96#
290deb8b 97# requirepass foobared
f2aa84bd 98
285add55 99################################### LIMITS ####################################
100
101# Set the max number of connected clients at the same time. By default there
102# is no limit, and it's up to the number of file descriptors the Redis process
103# is able to open. The special value '0' means no limts.
104# Once the limit is reached Redis will close all the new connections sending
105# an error 'max number of clients reached'.
3f477979 106#
285add55 107# maxclients 128
108
3fd78bcd 109# Don't use more memory than the specified amount of bytes.
110# When the memory limit is reached Redis will try to remove keys with an
111# EXPIRE set. It will try to start freeing keys that are going to expire
112# in little time and preserve keys with a longer time to live.
113# Redis will also try to remove objects from free lists if possible.
114#
115# If all this fails, Redis will start to reply with errors to commands
116# that will use more memory, like SET, LPUSH, and so on, and will continue
117# to reply to most read-only commands like GET.
144d479b 118#
119# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
120# 'state' server or cache, not as a real DB. When Redis is used as a real
121# database the memory usage will grow over the weeks, it will be obvious if
122# it is going to use too much memory in the long run, and you'll have the time
123# to upgrade. With maxmemory after the limit is reached you'll start to get
124# errors for write operations, and this may even lead to DB inconsistency.
3f477979 125#
3fd78bcd 126# maxmemory <bytes>
127
44b38ef4 128############################## APPEND ONLY MODE ###############################
129
130# By default Redis asynchronously dumps the dataset on disk. If you can live
131# with the idea that the latest records will be lost if something like a crash
132# happens this is the preferred way to run Redis. If instead you care a lot
133# about your data and don't want to that a single record can get lost you should
134# enable the append only mode: when this mode is enabled Redis will append
135# every write operation received in the file appendonly.log. This file will
136# be read on startup in order to rebuild the full dataset in memory.
137#
138# Note that you can have both the async dumps and the append only file if you
139# like (you have to comment the "save" statements above to disable the dumps).
140# Still if append only mode is enabled Redis will load the data from the
141# log file at startup ignoring the dump.rdb file.
0154acdc 142#
143# The name of the append only file is "appendonly.log"
49b99ab4 144#
145# IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
146# log file in background when it gets too big.
44b38ef4 147
4e141d5a 148appendonly no
44b38ef4 149
4e141d5a 150# The fsync() call tells the Operating System to actually write data on disk
48f0308a 151# instead to wait for more data in the output buffer. Some OS will really flush
152# data on disk, some other OS will just try to do it ASAP.
153#
154# Redis supports three different modes:
155#
156# no: don't fsync, just let the OS flush the data when it wants. Faster.
157# always: fsync after every write to the append only log . Slow, Safest.
158# everysec: fsync only if one second passed since the last fsync. Compromise.
159#
4e141d5a 160# The default is "always" that's the safer of the options. It's up to you to
161# understand if you can relax this to "everysec" that will fsync every second
162# or to "no" that will let the operating system flush the output buffer when
163# it want, for better performances (but if you can live with the idea of
164# some data loss consider the default persistence mode that's snapshotting).
48f0308a 165
4e141d5a 166appendfsync always
48f0308a 167# appendfsync everysec
4e141d5a 168# appendfsync no
48f0308a 169
a35ddf12 170################################ VIRTUAL MEMORY ###############################
171
4ef8de8a 172# Virtual Memory allows Redis to work with datasets bigger than the actual
173# amount of RAM needed to hold the whole dataset in memory.
174# In order to do so very used keys are taken in memory while the other keys
175# are swapped into a swap file, similarly to what operating systems do
176# with memory pages.
177#
178# To enable VM just set 'vm-enabled' to yes, and set the following three
179# VM parameters accordingly to your needs.
180
a35ddf12 181vm-enabled yes
4ef8de8a 182# vm-enabled no
183
184# vm-max-memory configures the VM to use at max the specified amount of
185# RAM. Everything that deos not fit will be swapped on disk *if* possible, that
186# is, if there is still enough contiguous space in the swap file.
187vm-max-memory 10000000
188
189# Redis swap files is split into pages. An object can be saved using multiple
190# contiguous pages, but pages can't be shared between different objects.
191# So if your page is too big, small objects swapped out on disk will waste
192# a lot of space. If you page is too small, there is less space in the swap
193# file (assuming you configured the same number of total swap file pages).
194#
195# If you use a lot of small objects, use a page size of 64 or 32 bytes.
196# If you use a lot of big objects, use a bigger page size.
197# If unsure, use the defualt :)
198vm-page-size 256
199
200# Number of total memory pages in the swap file.
201# Given that the page table (a bitmap of free/used pages) is taken in memory,
202# every 8 pages on disk will consume 1 byte of RAM.
203#
204# The total swap size is vm-page-size * vm-pages
205#
206# With the default of 256-bytes memory pages and 104857600 pages Redis will
207# use a 25 GB swap file, that will use rougly 13 MB of RAM for the page table.
208vm-pages 104857600
a35ddf12 209
ed9b544e 210############################### ADVANCED CONFIG ###############################
211
212# Glue small output buffers together in order to send small replies in a
213# single TCP packet. Uses a bit more CPU but most of the times it is a win
214# in terms of number of queries per second. Use 'yes' if unsure.
215glueoutputbuf yes
10c43610 216
217# Use object sharing. Can save a lot of memory if you have many common
218# string in your dataset, but performs lookups against the shared objects
219# pool so it uses more CPU and can be a bit slower. Usually it's a good
220# idea.
e52c65b9 221#
222# When object sharing is enabled (shareobjects yes) you can use
223# shareobjectspoolsize to control the size of the pool used in order to try
224# object sharing. A bigger pool size will lead to better sharing capabilities.
225# In general you want this value to be at least the double of the number of
226# very common strings you have in your dataset.
227#
228# WARNING: object sharing is experimental, don't enable this feature
229# in production before of Redis 1.0-stable. Still please try this feature in
230# your development environment so that we can test it better.
10c43610 231shareobjects no
e52c65b9 232shareobjectspoolsize 1024