Go to file
antirez 8ff874d2b2 2.2.15 release notes 2011-10-17 10:57:18 +02:00
client-libraries fixed client-libraries/README to reflect the new site path instead of google code 2011-02-22 18:22:00 +01:00
deps Slowlog backported to 2.2 2011-07-01 15:45:36 +02:00
design-documents Added more information about slave election in Redis Cluster alternative doc 2010-04-29 15:39:11 +02:00
doc added new HTML doc pages 2010-12-15 15:59:45 +01:00
src version bumped to 2.2.15 2011-10-17 10:56:12 +02:00
tests Add test for incorrect expiration when loading AOF. 2011-07-15 18:15:27 +02:00
utils Fixed init script bug, thanks to Henrik Westphal 2011-06-14 17:12:14 +02:00
.gitignore release notes added 2010-12-15 16:44:29 +01:00
00-RELEASENOTES 2.2.15 release notes 2011-10-17 10:57:18 +02:00
BUGS first commit 2009-03-22 10:30:00 +01:00
CONTRIBUTING Contributing file added 2010-09-23 18:24:47 +02:00
COPYING first commit 2009-03-22 10:30:00 +01:00
Changelog Make log target fixed 2010-07-01 14:45:37 +02:00
INSTALL Rename INSTALL_TOP to PREFIX; update documentation 2010-09-13 16:09:11 +01:00
Makefile Merge remote branch 'visionmedia/cli-help' into cli-help 2010-11-26 20:46:42 +01:00
README other minor README changes 2011-01-25 10:26:00 +01:00
TODO TODO file just pointing to the master branch TODO file 2010-12-20 13:16:38 +01:00
redis.conf Warn the user in redis.conf that VM is deprecated and discouraged 2011-07-15 18:10:20 +02:00

README

Where to find complete Redis documentation?
-------------------------------------------

This README is just a fast "quick start" document. You can find more detailed
documentation at http://redis.io

Building Redis
--------------

It is as simple as:

    % make

Redis is just a single binary, but if you want to install it you can use
the "make install" target that will copy the binary in /usr/local/bin
for default. You can also use "make PREFIX=/some/other/directory install"
if you wish to use a different destination.

You can run a 32 bit Redis binary using:

    % make 32bit

After building Redis is a good idea to test it, using:

    % make test

Buliding using tcmalloc
-----------------------

tcmalloc is a fast and space efficient implementation (for little objects)
of malloc(). Compiling Redis with it can improve performances and memeory
usage. You can read more about it here:

http://goog-perftools.sourceforge.net/doc/tcmalloc.html

In order to compile Redis with tcmalloc support install tcmalloc on your system
and then use:

    % make USE_TCMALLOC=yes

Note that you can pass any other target to make, as long as you append
USE_TCMALLOC=yes at the end.

Running Redis
-------------

To run Redis with the default configuration just type:

    % cd src
    % ./redis-server
    
If you want to provide your redis.conf, you have to run it using an additional
parameter (the path of the configuration file):

    % cd src
    % ./redis-server /path/to/redis.conf

Playing with Redis
------------------

You can use redis-cli to play with Redis. Start a redis-server instance,
then in another terminal try the following:

    % cd src
    % ./redis-cli
    redis> ping
    PONG
    redis> set foo bar
    OK
    redis> get foo
    "bar"
    redis> incr mycounter
    (integer) 1
    redis> incr mycounter
    (integer) 2
    redis> 

You can find the list of all the available commands here:

    http://redis.io/commands

Enjoy!