README

   1 = OMGF - hysterical REST API for MogileFS using Rack
   2
   3 OMGF provides an HTTP interface for {MogileFS}[http://mogilefs.org],
   4 allowing clients to connect to MogileFS without needing specialized
   5 libraries to interface with MogileFS.  Currently, HystericalRaisins
   6 is supported.  OMGF is short for "OMGFiles", an anagram for "MogileFS".
   7
   8 It is built on top of the
   9 {Ruby mogilefs-client}[http://yhbt.net/mogilefs-client] library
  10
  11 == Features
  12
  13 * Can be used unify multiple, independent MogileFS installations
  14   into a single HTTP endpoint.
  15
  16 == Install
  17
  18 OMGF is only compatible with Ruby 1.9.3 and later.
  19
  20 You may install it via RubyGems on RubyGems.org:
  21
  22   gem install omgf
  23
  24 == Usage
  25
  26  TODO...
  27
  28 == Development
  29
  30 You can get the latest source via git from the following locations
  31 (these versions may not be stable):
  32
  33   git://yhbt.net/omgf.git
  34   git://repo.or.cz/omgf.git (mirror)
  35
  36 You may browse the code from the web and download the latest snapshot
  37 tarballs here:
  38
  39 == Disclaimer
  40
  41 There is NO WARRANTY whatsoever if anything goes wrong, but let us know
  42 and we'll try our best to fix it.
  43
  44 All feedback (bug reports, user/development dicussion, patches, pull
  45 requests) go to the mailing list/newsgroup.  See the ISSUES document for
  46 information on the {omgf mailing list}[mailto:omgf@librelist.org]
  47
  48 You're can (and probably should) restrict access to OMGF hosts/ports.
  49 Anybody who can access OMGF must also be able to access the source code
  50 in accordance with the AGPL.  OMGF is not written/audited by a security
  51 expert, so it is likely not secure and you should only give trusted
  52 users access to it.
  53
  54 == License
  55
  56 OMGF is copyrighted Free Software by all contributors, see logs in
  57 revision control for names and email addresses of all of them.
  58
  59 You can redistribute OMGF and/or modify it under the terms of the GNU
  60 Affero General Public License, version 3 or later as published by the
  61 Free Software Foundation.
  62
  63 OMGF is distributed in the hope that it will be useful, but WITHOUT
  64 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  65 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public
  66 License for more details.
  67
  68 You should have received a copy of the GNU Affero General Public License
  69 along with OMGF; if not, see https://www.gnu.org/licenses