README.md

   1 uMurmur - minimalistic Mumble server
   2 ====================================
   3 Project page on [GoogleCode](http://code.google.com/p/umurmur/)
   4
   5 Source hosted on [GitHub](https://github.com/fatbob313/umurmur)
   6
   7 uMurmur is a minimalistic Mumble server primarily targeted to run on embedded computers, like routers, with an open OS like e.g. OpenWRT. The server part of Mumble is called Murmur, hence the name uMurmur. It is available as a precompiled package for quite a lot distributions. Check your distribution's package repository.
   8
   9 Instructions for building from source
  10 -------------------------------------
  11 1. Requirements
  12         * [OpenSSL](http://www.openssl.org/) or [PolarSSL](http://polarssl.org/) library. For PolarSSL version 1.0.0 and above is required.
  13         * [libconfig](http://www.hyperrealm.com/libconfig/)
  14         * [libprotoc-c](http://code.google.com/p/protobuf-c/) version 0.14 or 0.15 (use --disable-protoc option in its ./configure to build only the library). If you for some reason have to run an earlier version you need to recompile the protocol file `Mumble.proto` using the protobuf compiler for the corresponding version.
  15   * [CMake](http://cmake.org)
  16
  17 2. Build
  18         * Create a build folder and cd into it
  19         * `cmake ../` to use default settings (polarssl, no test-cert and /dev/urandom as source for randomness).
  20         * `make`
  21
  22 3. Install
  23         * `make install`
  24         * Edit the umurmur.conf found in the 'etc' folder in the prefix (eg. /usr/local) you installed to.
  25
  26 4. Run `umurmurd -c <conf file> -p <PID file> -r`. For other switches and their meaning run `umurmurd -h`
  27
  28 A startup script can easily be created if you want to. Just copy an existing script and edit it to your liking.
  29
  30 Contributors
  31 ------------
  32 * [Antoine Bertin](https://github.com/Diaoul)
  33 * [tilman2](http://code.google.com/u/@UhZTSlBWAxNMWgU%3D/)
  34 * J Sisson - sisson.j ( AT ) gmail DOT com
  35 * [pierre.h](http://code.google.com/u/@VBRUQ1ZTAhNEXwJ9/)
  36 * [phr0z3nt04st](https://github.com/phr0z3nt04st)
  37 * [Troy C](https://github.com/troxor)
  38 * [Trivve](https://github.com/Trivve)
  39 * [hasufell](https://github.com/hasufell)
  40 * [fmorgner](https://github.com/fmorgner)
  41 * [Rawi666](https://github.com/Rawi666)
  42
  43 Hope I didn't forget anyone... Please just send me a mail if you feel this is the case.
  44
  45 Support/Contact/Documentation
  46 -----------------------------
  47 See the project page, link above.
  48
  49 Have fun!