doc/QuickStart.html

   1
   2 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
   3 <html>
   4     <head>
   5         <link type="text/css" rel="stylesheet" href="style.css" />
   6     </head>
   7     <body>
   8         <div id="page">
   9
  10             <div id='header'>
  11             <a href="index.html">
  12             <img style="border:none" alt="Redis Documentation" src="redis.png">
  13             </a>
  14             </div>
  15
  16             <div id="pagecontent">
  17                 <div class="index">
  18 <!-- This is a (PRE) block.  Make sure it's left aligned or your toc title will be off. -->
  19 <b>QuickStart: Contents</b><br>&nbsp;&nbsp;<a href="#Quick Start">Quick Start</a><br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="#Obtaining the latest version of Redis">Obtaining the latest version of Redis</a><br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="#Compiling Redis">Compiling Redis</a><br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="#Running Redis">Running Redis</a><br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="#Testing Redis">Testing Redis</a><br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="#Further reading">Further reading</a>
  20                 </div>
  21
  22                 <h1 class="wikiname">QuickStart</h1>
  23
  24                 <div class="summary">
  25
  26                 </div>
  27
  28                 <div class="narrow">
  29                     <h1><a name="Quick Start">Quick Start</a></h1>This quickstart is a five minutes howto on how to get started with Redis. For more information on Redis check <a href="http://code.google.com/p/redis/wiki/index" target="_blank">Redis Documentation Index</a>.<h2><a name="Obtaining the latest version of Redis">Obtaining the latest version of Redis</a></h2>The latest stable source distribution of Redis can be obtained <a href="http://code.google.com/p/redis/downloads/list" target="_blank">at this location as a tarball</a>. The unstable source code, with more features but not ready for production, can be downloaded using git:<br/><br/><pre class="codeblock python" name="code">
  30 git clone git://github.com/antirez/redis.git
  31 </pre><h2><a name="Compiling Redis">Compiling Redis</a></h2>Redis can be compiled in most POSIX systems, but the development targets mainly Linux, Mac OS X, FreeBSD and OpenBSD. Solaris is currently not supported and there are no short-term plans to support it.<br/><br/>To compile Redis just untar the tar.gz, enter the directly and type 'make'.<br/><br/><pre class="codeblock python python" name="code">
  32 tar xvzf redis-1.0.0.tar.gz
  33 cd redis-1.0.0
  34 make
  35 </pre>In order to test if the Redis server is working well in your computer make sure to run <code name="code" class="python">make test</code>and check that all the tests are passed.<h2><a name="Running Redis">Running Redis</a></h2>Redis can run just fine without a configuration file (when executed without a config file a standard configuration is used). To run Redis just type the following command:<br/><br/><pre class="codeblock python python python" name="code">
  36 ./redis-server
  37 </pre>With the default configuration Redis will log to the standard output so you can check what happens. Later, when you'll ready to install Redis in production, you may want to use a configuration file. The <code name="code" class="python">redis.conf</code> file included in the source code distribution is a starting point, you should be able to modify it in order do adapt it to your needs without troubles reading the comments inside the file. In order to start Redis using a configuration file just pass the file name as the sole argument when starting the server:<br/><br/><pre class="codeblock python python python python" name="code">
  38 ./redis-server redis.conf
  39 </pre><h2><a name="Testing Redis">Testing Redis</a></h2>To check if the server is working correctly you can use the <code name="code" class="python">redis-cli</code> utility included in the source distribution (and automatically compiled when you compile Redis). For instance to set a key and read back the value use the following:<br/><br/><pre class="codeblock python python python python python" name="code">
  40 ./redis-cli set mykey somevalue
  41 OK
  42 ./redis-cli get mykey
  43 somevalue
  44 </pre><h2><a name="Further reading">Further reading</a></h2><ul><li> To know more about Redis check the <a href="README.html">Readme</a> file.</li><li> Read the full list of available commands in the <a href="CommandReference.html">Command Reference</a>.</li><li> To get started with the Redis replication read the <a href="ReplicationHowto.html">Replication Howto</a>.</li></ul>
  45                 </div>
  46
  47             </div>
  48         </div>
  49     </body>
  50 </html>
  51