README

   1 = mogilefs-client - MogileFS client library for Ruby
   2
   3 A MogileFS client library for Ruby.  MogileFS is an open source
   4 distributed filesystem, see:
   5 https://github.com/mogilefs/MogileFS-Server/wiki for more
   6 details.  This library allows any Ruby application to read,
   7 write and delete files in a MogileFS instance.
   8
   9 == Links
  10
  11 rdoc :: https://yhbt.net/mogilefs-client
  12 mogilefs :: git clone https://github.com/mogilefs/MogileFS-Server
  13 list :: mailto:mogilefs-client-public@yhbt.net
  14 list-cc :: mailto:mogile@googlegroups.com
  15 list-archive :: https://yhbt.net/mogilefs-client-public
  16 repo :: https://yhbt.net/mogilefs-client.git
  17 gitweb :: http://repo.or.cz/w/ruby-mogilefs-client.git
  18 download :: https://yhbt.net/mogilefs-client/files/
  19
  20 == Install
  21
  22 First you need a MogileFS 2.x installation.  You can find information on
  23 how to do that at https://github.com/mogilefs/MogileFS-Server/wiki
  24
  25 Then install the RubyGem:
  26
  27   $ gem install mogilefs-client
  28
  29 This library supports Ruby 1.8.7 and later, but Ruby 1.9.3 is
  30 recommended.  No other libraries are required on the client.
  31
  32 == Usage
  33
  34 See MogileFS::MogileFS
  35
  36 == Contact
  37
  38 Feedback (bug reports, user/development discussion, patches, pull
  39 requests) are greatly appreciated and handled via email to a public
  40 inbox.  HTML email is considered spam and discarded.  No subscription
  41 is required or available to post:
  42
  43         mogilefs-client-public@yhbt.net
  44
  45 Users of anonymous remailers and other anonymity tools are welcome.
  46 Participants will never be asked to reveal their identity.
  47
  48 List archives: https://yhbt.net/mogilefs-client-public/
  49
  50 We may also piggy-back onto the public MogileFS mailing list at
  51 mogile@googlegroups.com for feedback (subscription required,
  52 unfortunately)
  53
  54 Do not expect us to read HTML mail under any circumstances.
  55
  56 == WARNING!
  57
  58 This client is only supported in HTTP mode.  NFS mode was previously
  59 supported in 1.3.x, but since MogileFS 2.x dropped support for NFS
  60 in in 2006, this client does not support it.