Go to file
Jan Oberst e491a1a1a8 Cleaned up redis root directory and changed links for redis.io and github issues and pull requests 2011-10-18 14:14:16 -04:00
deps master branch merged into scripting. 2011-07-12 12:39:16 +02:00
src Fixed a small memory leak I found with valgrind 2011-10-18 20:18:26 +09:00
tests Regression test for issue #142 added 2011-10-17 10:41:46 +02:00
utils fixes to install script 2011-10-04 16:58:55 +02:00
.gitignore Untrack and ignore Lua binary files (2) 2011-06-14 18:08:45 +02:00
BUGS first commit 2009-03-22 10:30:00 +01:00
CONTRIBUTING Cleaned up redis root directory and changed links for redis.io and github issues and pull requests 2011-10-18 14:14:16 -04: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 Small fix in the installation instructions 2011-06-09 09:14:18 -07:00
Makefile top level Makefile now just a proxy. Doing make clean inside src now does a full clean including deps, not just Redis source. Thanks to Pieter for the top level Makefile proxy trick. 2011-07-13 19:15:22 +02:00
README Cleaned up redis root directory and changed links for redis.io and github issues and pull requests 2011-10-18 14:14:16 -04:00
TODO a few entries removed from the old TODO list (done) 2011-09-27 16:07:38 +02:00
redis.conf Added a config directive for a Unix socket mask 2011-10-10 11:21:15 -07:00
runtest Added a 'runtest' script that is responsible to check if Tcl is available and run the test. This is invoked from Makefile as well. 2011-07-15 17:20:57 +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: http://redis.io/documentation


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 to /usr/local/bin
by 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 (which require Tcl), 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://redis.io/commands

Enjoy!