README

   1 cmogstored - alternative mogstored implementation for MogileFS
   2 --------------------------------------------------------------
   3
   4 cmogstored is an alternative implementation of the "mogstored" storage
   5 component of MogileFS.  cmogstored is implemented in C and does not use
   6 Perl at runtime.  cmogstored is the only component you need to install
   7 on a MogileFS storage node.
   8
   9 Read more about MogileFS at https://github.com/mogilefs/MogileFS-Server
  10 cmogstored is not directly affiliated with the MogileFS project
  11 nor any commercial interests behind MogileFS.
  12
  13 Features
  14 ========
  15
  16 * low memory footprint, more memory for file system caches
  17 * multithreaded design[1] keeps queues in rotational disks busy
  18 * epoll/kqueue used to cheaply maintain persistent connections
  19 * supports checksumming features in MogileFS::Server 2.60+
  20 * easily installable on modern GNU/Linux and FreeBSD without Perl
  21 * supports HTTP/1.1 persistent connections and pipelining
  22 * supports chunked and partial (Content-Range) HTTP/1.1 PUT requests
  23 * supports partial GET requests
  24 * may reject PUTs based on Content-MD5 header/trailer verification
  25 * graceful shutdown via SIGQUIT will not terminate active requests
  26 * extensive test suite, code coverage and Valgrind-tested
  27
  28 Getting Started
  29 ===============
  30
  31 See the INSTALL document for installation and runtime requirements.
  32
  33 cmogstored aims to be mostly command-line and configuration-file
  34 compatible with the Perl mogstored.
  35
  36 cmogstored does not support spawning lighttpd/Apache instances like its
  37 Perl counterpart.
  38
  39 In other cases, you can simply replace "mogstored" with "cmogstored"
  40 in your init scripts and use the same config file.
  41
  42 Contact
  43 =======
  44
  45 For any and all questions, bug reports, patches, pull requests,
  46 send plain-text email to our publically archived inbox at:
  47
  48         cmogstored-public@yhbt.net
  49
  50 No subscription is neccessary, so reply-to-all on replies.
  51 HTML email is not welcome and will be bounced.
  52
  53 Our archives are at https://yhbt.net/cmogstored-public/
  54 and via NNTP(S) and IMAP(S):
  55
  56   nntps://news.public-inbox.org/inbox.comp.file-systems.mogilefs.cmogstored
  57   imaps://news.public-inbox.org/inbox.comp.file-systems.mogilefs.cmogstored.0
  58
  59 Tor users may also use .onions:
  60
  61   nntp://ou63pmih66umazou.onion/inbox.comp.file-systems.mogilefs.cmogstored
  62   imap://ou63pmih66umazou.onion/inbox.comp.file-systems.mogilefs.cmogstored.0
  63
  64 AUTH=ANONYMOUS is supported if your IMAP(S) client supports it,
  65 but any username + password combination also works.
  66
  67 We also piggy-back onto the public MogileFS mailing list for public
  68 discussions:
  69
  70         mogile@googlegroups.com
  71
  72 Note, subscription required for the MogileFS list:
  73
  74         mogile+subscribe@googlegroups.com
  75
  76 MogileFS archives are at: <https://groups.google.com/forum/#!forum/mogile>
  77
  78 Downloads
  79 =========
  80
  81 Source tarballs suitable for distribution are housed here:
  82
  83 * https://yhbt.net/cmogstored/files/
  84
  85 The latest stable release is:
  86         https://yhbt.net/cmogstored/files/cmogstored-1.8.1.tar.gz
  87
  88 See https://yhbt.net/cmogstored/NEWS for release notes
  89
  90 Source code
  91 ===========
  92
  93 * git clone https://yhbt.net/cmogstored.git
  94 * gitweb :: https://repo.or.cz/w/cmogstored.git
  95
  96 License
  97 =======
  98
  99 cmogstored is licensed under the GNU General Public License, v3 (or later).
 100 Distribution tarballs include LGPL code from the Gnulib project in lib/.
 101 The bsd/*.h compatibility headers are BSD-licensed.
 102 The nostd/* files are Expat/MIT-licensed from the libnostd project
 103 Contributors retain their copyrights to their respective contributions.
 104
 105 This project is not affiliated with the GNU project nor FSF even though
 106 we use their tools and licenses.
 107
 108 Homepage
 109 ========
 110
 111 Eric Wong hates pretty things, so this README file is also the homepage:
 112 https://yhbt.net/cmogstored/README
 113
 114 The latest releases are announced via Atom feed:
 115 https://yhbt.net/cmogstored/NEWS.atom.xml
 116
 117 [1] https://yhbt.net/cmogstored/queues.txt