Skip to content
Newer
Older
100644 84 lines (56 sloc) 1.91 KB
d320764 @antirez We finally have an half decent README! (Issue 277)
authored
1 Where to find complete Redis documentation?
2 -------------------------------------------
3
4 This README is just a fast "quick start" document. You can find more detailed
5ef8f95 @antirez other minor README changes
authored
5 documentation at http://redis.io
d320764 @antirez We finally have an half decent README! (Issue 277)
authored
6
7 Building Redis
8 --------------
9
10 It is as simple as:
11
12 % make
13
14 Redis is just a single binary, but if you want to install it you can use
15 the "make install" target that will copy the binary in /usr/local/bin
e138650 @melo Rename INSTALL_TOP to PREFIX; update documentation
melo authored
16 for default. You can also use "make PREFIX=/some/other/directory install"
17 if you wish to use a different destination.
d320764 @antirez We finally have an half decent README! (Issue 277)
authored
18
19 You can run a 32 bit Redis binary using:
20
21 % make 32bit
22
3ce30a6 @antirez README updated
authored
23 After building Redis is a good idea to test it, using:
d320764 @antirez We finally have an half decent README! (Issue 277)
authored
24
25 % make test
26
0a802bd @antirez support for compiling with tcmalloc
authored
27 Buliding using tcmalloc
28 -----------------------
29
fc41345 @antirez README more specific about tcmalloc space benefits
authored
30 tcmalloc is a fast and space efficient implementation (for little objects)
31 of malloc(). Compiling Redis with it can improve performances and memeory
32 usage. You can read more about it here:
33
34 http://goog-perftools.sourceforge.net/doc/tcmalloc.html
0a802bd @antirez support for compiling with tcmalloc
authored
35
36 In order to compile Redis with tcmalloc support install tcmalloc on your system
37 and then use:
38
39 % make USE_TCMALLOC=yes
40
41 Note that you can pass any other target to make, as long as you append
42 USE_TCMALLOC=yes at the end.
43
d320764 @antirez We finally have an half decent README! (Issue 277)
authored
44 Running Redis
45 -------------
46
47 To run Redis with the default configuration just type:
48
49 % cd src
50 % ./redis-server
51
52 If you want to provide your redis.conf, you have to run it using an additional
53 parameter (the path of the configuration file):
54
55 % cd src
56 % ./redis-server /path/to/redis.conf
57
58 Playing with Redis
59 ------------------
60
61 You can use redis-cli to play with Redis. Start a redis-server instance,
62 then in another terminal try the following:
63
64 % cd src
65 % ./redis-cli
66 redis> ping
67 PONG
68 redis> set foo bar
69 OK
70 redis> get foo
71 "bar"
72 redis> incr mycounter
73 (integer) 1
74 redis> incr mycounter
75 (integer) 2
76 redis>
77
78 You can find the list of all the available commands here:
79
3ce30a6 @antirez README updated
authored
80 http://redis.io/commands
d320764 @antirez We finally have an half decent README! (Issue 277)
authored
81
82 Enjoy!
83
Something went wrong with that request. Please try again.