]>
Commit | Line | Data |
---|---|---|
d3207647 | 1 | Where to find complete Redis documentation? |
2 | ------------------------------------------- | |
3 | ||
4 | This README is just a fast "quick start" document. You can find more detailed | |
3fb1c8a0 | 5 | documentation at http://redis.io |
d3207647 | 6 | |
7 | Building Redis | |
8 | -------------- | |
9 | ||
10 | It is as simple as: | |
11 | ||
12 | % make | |
13 | ||
d3207647 | 14 | You can run a 32 bit Redis binary using: |
15 | ||
16 | % make 32bit | |
17 | ||
3fb1c8a0 | 18 | After building Redis is a good idea to test it, using: |
d3207647 | 19 | |
20 | % make test | |
21 | ||
3fb1c8a0 JO |
22 | NOTE: if after building Redis with a 32 bit target you need to rebuild it |
23 | with a 64 bit target you need to perform a "make clean" in the root | |
24 | directory of the Redis distribution. | |
25 | ||
26 | Allocator | |
27 | --------- | |
28 | ||
a63a3d4d PN |
29 | Selecting a non-default memory allocator when building Redis is done by setting |
30 | the `MALLOC` environment variable. Redis is compiled and linked against libc | |
31 | malloc by default, with the exception of jemalloc being the default on Linux | |
32 | systems. This default was picked because jemalloc has proven to have fewer | |
33 | fragmentation problems than libc malloc. | |
3fb1c8a0 | 34 | |
a63a3d4d | 35 | To force compiling against libc malloc, use: |
3fb1c8a0 | 36 | |
a63a3d4d | 37 | % make MALLOC=libc |
3fb1c8a0 | 38 | |
a63a3d4d | 39 | To compile against jemalloc on Mac OS X systems, use: |
3fb1c8a0 | 40 | |
a63a3d4d | 41 | % make MALLOC=jemalloc |
3fb1c8a0 JO |
42 | |
43 | Verbose build | |
44 | ------------- | |
45 | ||
46 | Redis will build with a user friendly colorized output by default. | |
47 | If you want to see a more verbose output use the following: | |
48 | ||
ca1f766a | 49 | % make V=1 |
0a802bd7 | 50 | |
d3207647 | 51 | Running Redis |
52 | ------------- | |
53 | ||
54 | To run Redis with the default configuration just type: | |
55 | ||
56 | % cd src | |
57 | % ./redis-server | |
58 | ||
59 | If you want to provide your redis.conf, you have to run it using an additional | |
60 | parameter (the path of the configuration file): | |
61 | ||
62 | % cd src | |
63 | % ./redis-server /path/to/redis.conf | |
64 | ||
1576520c | 65 | It is possible to alter the Redis configuration passing parameters directly |
66 | as options using the command line. Examples: | |
67 | ||
68 | % ./redis-server --port 9999 --slaveof 127.0.0.1 6379 | |
69 | % ./redis-server /etc/redis/6379.conf --loglevel debug | |
70 | ||
71 | All the options in redis.conf are also supported as options using the command | |
72 | line, with exactly the same name. | |
73 | ||
d3207647 | 74 | Playing with Redis |
75 | ------------------ | |
76 | ||
77 | You can use redis-cli to play with Redis. Start a redis-server instance, | |
78 | then in another terminal try the following: | |
79 | ||
80 | % cd src | |
81 | % ./redis-cli | |
82 | redis> ping | |
83 | PONG | |
84 | redis> set foo bar | |
85 | OK | |
86 | redis> get foo | |
87 | "bar" | |
88 | redis> incr mycounter | |
89 | (integer) 1 | |
90 | redis> incr mycounter | |
91 | (integer) 2 | |
92 | redis> | |
93 | ||
94 | You can find the list of all the available commands here: | |
95 | ||
e491a1a1 | 96 | http://redis.io/commands |
d3207647 | 97 | |
ca1f766a | 98 | Installing Redis |
99 | ----------------- | |
100 | ||
101 | In order to install Redis binaries into /usr/local/bin just use: | |
102 | ||
103 | % make install | |
104 | ||
105 | You can use "make PREFIX=/some/other/directory install" if you wish to use a | |
106 | different destination. | |
107 | ||
108 | Make install will just install binaries in your system, but will not configure | |
109 | init scripts and configuration files in the appropriate place. This is not | |
110 | needed if you want just to play a bit with Redis, but if you are installing | |
111 | it the proper way for a production system, we have a script doing this | |
112 | for Ubuntu and Debian systems: | |
113 | ||
114 | % cd utils | |
115 | % ./install_server | |
116 | ||
117 | The script will ask you a few questions and will setup everything you need | |
118 | to run Redis properly as a background daemon that will start again on | |
119 | system reboots. | |
120 | ||
121 | You'll be able to stop and start Redis using the script named | |
122 | /etc/init.d/redis_<portnumber>, for instance /etc/init.d/redis_6379. | |
123 | ||
d3207647 | 124 | Enjoy! |