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