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 Source repository (git):
  18
  19 git://git.bogomips.org/mogilefs-client.git
  20 http://git.bogomips.org/mogilefs-client.git
  21
  22 Repository browser (cgit):
  23
  24 http://git.bogomips.org/cgit/mogilefs-client.git
  25
  26 == About
  27
  28 A Ruby MogileFS client.  MogileFS is a distributed filesystem written
  29 by Danga Interactive.  This client supports NFS and HTTP modes.
  30
  31 For information on MogileFS see:
  32
  33 http://danga.com/mogilefs/
  34
  35 == Installing mogilefs-client
  36
  37 First you need a MogileFS setup.  You can find information on how to do
  38 that at the above URL.
  39
  40 Then install the gem:
  41
  42   $ sudo gem install mogilefs-client
  43
  44 == Using mogilefs-client
  45
  46   # Create a new instance that will communicate with these trackers:
  47   hosts = %w[192.168.1.69:6001 192.168.1.70:6001]
  48   mg = MogileFS::MogileFS.new(:domain => 'test', :hosts => hosts)
  49
  50   # NFS requires the :root parameter (e.g. :root => '/mnt/mogilefs')
  51
  52   # Stores "A bunch of text to store" into 'some_key' with a class of 'text'.
  53   mg.store_content 'some_key', 'text', "A bunch of text to store"
  54
  55   # Retrieve data from 'some_key'
  56   data = mg.get_file_data 'some_key'
  57
  58   # Store the contents of 'image.jpeg' into the key 'my_image' with a class of
  59   # 'image'.
  60   mg.store_file 'my_image', 'image', 'image.jpeg'
  61
  62   # Store the contents of 'image.jpeg' into the key 'my_image' with a class of
  63   # 'image' using an open IO.
  64   File.open 'image.jpeg' do |fp|
  65     mg.store_file 'my_image', 'image', fp
  66   end
  67
  68   # Remove the key 'my_image' and 'some_key'.
  69   mg.delete 'my_image'
  70   mg.delete 'some_key'
  71
  72 == WARNING!
  73
  74 This client is only supported in HTTP mode.  NFS mode was previously
  75 supported but since MogileFS 2.x has dropped support for NFS, do not
  76 expect it to remain working forever.