about summary refs log tree commit homepage
= mogilefs-client - MogileFS client library for Ruby

A MogileFS client library for Ruby.  MogileFS is an open source
distributed filesystem, see:
https://github.com/mogilefs/MogileFS-Server/wiki for more
details.  This library allows any Ruby application to read,
write and delete files in a MogileFS instance.

== Links

rdoc :: https://yhbt.net/mogilefs-client
mogilefs :: git clone https://github.com/mogilefs/MogileFS-Server
list :: mailto:mogilefs-client-public@yhbt.net
list-cc :: mailto:mogile@googlegroups.com
list-archive :: https://yhbt.net/mogilefs-client-public
repo :: https://yhbt.net/mogilefs-client.git
gitweb :: http://repo.or.cz/w/ruby-mogilefs-client.git
download :: https://yhbt.net/mogilefs-client/files/

== Install

First you need a MogileFS 2.x installation.  You can find information on
how to do that at https://github.com/mogilefs/MogileFS-Server/wiki

Then install the RubyGem:

  $ gem install mogilefs-client

This library supports Ruby 1.8.7 and later, but Ruby 1.9.3 is
recommended.  No other libraries are required on the client.

== Usage

See MogileFS::MogileFS

== Contact

Feedback (bug reports, user/development discussion, patches, pull
requests) are greatly appreciated and handled via email to a public
inbox.  HTML email is considered spam and discarded.  No subscription
is required or available to post:

	mogilefs-client-public@yhbt.net

Users of anonymous remailers and other anonymity tools are welcome.
Participants will never be asked to reveal their identity.

List archives: https://yhbt.net/mogilefs-client-public/

We may also piggy-back onto the public MogileFS mailing list at
mogile@googlegroups.com for feedback (subscription required,
unfortunately)

Do not expect us to read HTML mail under any circumstances.

== WARNING!

This client is only supported in HTTP mode.  NFS mode was previously
supported in 1.3.x, but since MogileFS 2.x dropped support for NFS
in in 2006, this client does not support it.