README.txt

   1 = mogilefs-client
   2
   3 A Ruby MogileFS client
   4
   5 Rubyforge Project:
   6
   7 http://rubyforge.org/projects/seattlerb/
   8
   9 Documentation:
  10
  11 http://seattlerb.org/mogilefs-client
  12
  13 File bugs:
  14
  15 http://rubyforge.org/tracker/?func=add&group_id=1513&atid=5921
  16
  17 == About
  18
  19 A Ruby MogileFS client.  MogileFS is a distributed filesystem written
  20 by Danga Interactive.  This client supports NFS and HTTP modes.
  21
  22 For information on MogileFS see:
  23
  24 http://danga.com/mogilefs/
  25
  26 == Installing mogilefs-client
  27
  28 First you need a MogileFS setup.  You can find information on how to do that at the above URL.
  29
  30 Then install the gem:
  31
  32   $ sudo gem install mogilefs-client
  33
  34 == Using mogilefs-client
  35
  36   # Create a new instance that will communicate with these trackers:
  37   hosts = %w[192.168.1.69:6001 192.168.1.70:6001]
  38   mg = MogileFS::MogileFS.new(:domain => 'test', :hosts => hosts
  39                               :root => '/mnt/mogilefs')
  40
  41   # Stores "A bunch of text to store" into 'some_key' with a class of 'text'.
  42   mg.store_content 'some_key', 'text', "A bunch of text to store"
  43
  44   # Retrieve data from 'some_key'
  45   data = mg.get_file_data 'some_key'
  46
  47   # Store the contents of 'image.jpeg' into the key 'my_image' with a class of
  48   # 'image'.
  49   mg.store_file 'my_image', 'image', 'image.jpeg'
  50
  51   # Store the contents of 'image.jpeg' into the key 'my_image' with a class of
  52   # 'image' using an open IO.
  53   File.open 'image.jpeg' do |fp|
  54     mg.store_file 'my_image', 'image', fp
  55   end
  56
  57   # Remove the key 'my_image' and 'some_key'.
  58   mg.delete 'my_image'
  59   mg.delete 'some_key'
  60
  61 == WARNING!
  62
  63 This client is only known to work in NFS mode.  HTTP mode is implemented but
  64 only lightly tested in production environments.  If you find a bug,
  65 please report it on the Rubyforge project.
  66