Commits

Anonymous committed 44b0143 Merge

merge

Comments (0)

Files changed (4)

                            Welcome to Riak.
                            ================
 
-Date: 2010-03-09 15:01:47 EST
+Date: 2010-03-10 01:18:20 CST
 
 
 
    Assuming you have a working Erlang (R13B03 or later) installation,
    building Riak should be as simple as:
 
+
   $ cd $RIAK
   $ make rel
 
-
 2.2 Starting Riak 
 ==================
 
    Once you have successfully built Riak, you can start the server with the
    following commands:
 
+
   $ cd $RIAK/rel/riak
   $ bin/riak start
 
-
    Now, verify that the server started up cleanly and is working:
 
    $ bin/riak-admin test
    Now that you have a functional server, let's try storing some data in
    it. First, start up a erlang node using our embedded version of erlang:
 
+
   $ erts-<vsn>/bin/erl -name riaktest@127.0.0.1 -setcookie riak
   
   Eshell V5.7.4  (abort with ^G)
   (riaktest@127.0.0.1)1>
 
+   Now construct the node name of Riak server and make sure we can talk to it:
 
-   Now construct the node name of Riak server and make sure we can talk to it:
 
   (riaktest@127.0.0.1)4> RiakNode = 'riak@127.0.0.1'.
   
   (riaktest@127.0.0.1)2> net_adm:ping(RiakNode).
   pong
   (riaktest@127.0.0.1)2>
-
    
    We are now ready to start the Riak client:
 
+
   (riaktest@127.0.0.1)2> {ok, C} = riak:client_connect(RiakNode).
-  {ok,{riak_client,'riak@127.0.0.1',4,136,81,151}}
-
+  {ok,{riak_client,'riak@127.0.0.1',<<4,136,81,151>>}}
 
    Let's create a shopping list for bread at /groceries/mine:
 
-  (riaktest@127.0.0.1)6> O0 = riak_object:new("groceries", "mine", ["bread"]).
-  O0 = riak_object:new("groceries", "mine", ["bread"]).
-  {r_object,"groceries","mine",
+
+  (riaktest@127.0.0.1)6> O0 = riak_object:new(<<"groceries">>, <<"mine">>, ["bread"]).
+  O0 = riak_object:new(<<"groceries">>, <<"mine">>, ["bread"]).
+  {r_object,<<"groceries">>,<<"mine">>,
          [{r_content,{dict,0,16,16,8,80,48,
                            {[],[],[],[],[],[],[],[],[],[],[],[],[],[],...},
                            {{[],[],[],[],[],[],[],[],[],[],[],[],...}}},
          undefined}
   
    (riaktest@127.0.0.1)3> C:put(O0, 1).
-
     
     Now, read the list back from the Riak server and extract the value
 
-  (riaktest@127.0.0.1)4> {ok, O1} = C:get("groceries", "mine", 1).
-  {ok,{r_object,"groceries","mine",
+
+  (riaktest@127.0.0.1)4> {ok, O1} = C:get(<<"groceries">>, <<"mine">>, 1).
+  {ok,{r_object,<<"groceries">>,<<"mine">>,
             [{r_content,{dict,2,16,16,8,80,48,
                               {[],[],[],[],[],[],[],[],[],[],[],[],...},
                               {{[],[],[],[],[],[],
    (riaktest@127.0.0.1)5> V = riak_object:get_value(O1).
    ["bread"]
 
+     Add milk to our list of groceries and write the new value to Riak:
 
-     Add milk to our list of groceries and write the new value to Riak:
 
   (riaktest@127.0.0.1)6> %% add milk to the list
   (riaktest@127.0.0.1)6> O2 = riak_object:update_value(O1, ["milk" | V]).
-  {r_object,"groceries","mine",
+  {r_object,<<"groceries">>,<<"mine">>,
        [{r_content,{dict,2,16,16,8,80,48,
                          {[],[],[],[],[],[],[],[],[],[],[],[],[],[],...},
                          {{[],[],[],[],[],[],
   (riaktest@127.0.0.1)7> C:put(O2, 1).
   ok
 
-
      Finally, see what other keys are available in groceries bucket:
 
-  (riaktest@127.0.0.1)8> C:list_keys("groceries").
-  {ok,["mine"]}
 
+  (riaktest@127.0.0.1)8> C:list_keys(<<"groceries">>).
+  {ok,[<<"mine">>]}
 
 
 3 Server Management 
 
     To join a new Riak node to an existing cluster:
 
+
   $ bin/riak start # If a local server is not already running
   $ bin/riak-admin join <node in cluster>
 
-
     (Note that you must have a local node already running for this to work)
     
     To verify that the local Riak node is able to read/write data:
   platforms supporting [[http://erlang.org/][Erlang]] releases R13B03 and later.
 
 ** Binary Releases
-*** TODO where do binary releases come from?
-*** TODO List of OS packages
+*** Overview
+
+    Riak can be downloaded in a binary form negating the need to 
+    to install the latest Erlang and compile from source. The binary
+    distribution of Riak doesn't include innostore. Innostore must
+    be compiled and installed manually. You can find out more about
+    innostore at http://hg.basho.com/innostore/.
+
+    Currently Riak is offered in binary form for rpm and deb based
+    Linux systems.
+
+*** RPM Based Linux Distributions
+    
+    Riak can be installed in binary form on many RPM based systems,
+    the current target platforms are RHEL and Centos. Riak can be
+    download in both 64bit and 32bit binaries in rpm format here:
+    32bit: http://downloads.basho.com/riak-0.9.0-1.i386.rpm
+    64bit: http://downloads.basho.com/riak-0.9.0-1.x86_64.rpm
+    
+    Note: On 32bit systems you may need to disable SE Linux if 
+    it is enabled.
+
+*** Deb Based Linux Distributions
+
+   Riak can be installed in binary form on many systems that use the
+   Debian packaging system, the current target platforms are
+   Ubuntu and Debian.  Riak can be download in both 64bit and 32bit
+   binaries in deb format here:
+   32bit: http://downloads.basho.com/riak_0.9.0-1_i386.deb
+   64bit: http://downloads.basho.com/riak_0.9.0-1_amd64.deb
 
 ** Source Releases
 *** Prerequisites

doc/man/man1/riak-admin.1.gz

Binary file added.

doc/man/man1/riak.1.gz

Binary file added.