Go to file
antirez 1dd10ca233 maxmemory fixed, we now try to release memory just before we check for the memory limit. Before fixing there was code between the attempt to free memory and the check for memory limits, and this code could result into allocations going again after the memory limit. 2010-10-11 13:05:09 +02:00
client-libraries client-libraries directory readded 2009-11-03 12:05:13 +01:00
design-documents Added more information about slave election in Redis Cluster alternative doc 2010-04-29 15:39:11 +02:00
doc Fix for solaris compilation bug Issue 325 2010-09-06 10:12:44 +02:00
src maxmemory fixed, we now try to release memory just before we check for the memory limit. Before fixing there was code between the attempt to free memory and the check for memory limits, and this code could result into allocations going again after the memory limit. 2010-10-11 13:05:09 +02:00
tests intset stress testing added, ziplist stress testing relocated in a more appropriate place 2010-09-24 11:15:06 +02:00
utils Fix for the init script provided with Redis, thanks to Rowan. This fixes issue 316 2010-09-09 10:24:56 +02:00
.gitignore gitignore modified 2010-07-01 14:41:03 +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 Make install fixed using a dummy taget 2010-07-06 19:10:20 +02:00
README Rename INSTALL_TOP to PREFIX; update documentation 2010-09-13 16:09:11 +01:00
TODO TODO list modified, trivial change to source code 2010-07-16 23:56:18 +02:00
redis.conf redis.conf new features the new option, a minor typo preventing the compilation fixed 2010-05-28 10:48:04 +02:00

README

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

This README is just a fast "quick start" document. You can find more detailed
documentation here:

1) http://code.google.com/p/redis
2) Check the 'doc' directory. doc/README.html is a good starting point :)

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 you build Redis is a good idea to test it, using:

    % make test

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://code.google.com/p/redis/wiki/CommandReference

Enjoy!