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
  16 2. Build
  17         * `./autogen.sh` - Required only if building from a cloned Git tree.
  18         * `./configure` - use `./configure --help` for switches. Defaults to build using PolarSSL, no test certificate, `/dev/urandom` as random source.
  19         * `make`
  20
  21 3. Install
  22         * `make install`
  23         * Edit umurmur.conf.example to your liking and put it in a suitable place. /etc/umurmur.conf is default.
  24
  25 4. Run `umurmurd -c <conf file> -p <PID file> -r`. For other switches and their meaning run `umurmurd -h`
  26
  27 A startup script can easily be created if you want to. Just copy an existing script and edit it to your liking.
  28
  29 Contributors
  30 ------------
  31 * [Antoine Bertin](https://github.com/Diaoul)
  32 * [tilman2](http://code.google.com/u/@UhZTSlBWAxNMWgU%3D/)
  33 * J Sisson - sisson.j ( AT ) gmail DOT com
  34 * [pierre.h](http://code.google.com/u/@VBRUQ1ZTAhNEXwJ9/)
  35 * [phr0z3nt04st](https://github.com/phr0z3nt04st)
  36 * [Troy C](https://github.com/troxor)
  37 * [Trivve](https://github.com/Trivve)
  38 * [hasufell](https://github.com/hasufell)
  39 * [fmorgner](https://github.com/fmorgner)
  40 * [Rawi666](https://github.com/Rawi666)
  41
  42 Hope I didn't forget anyone... Please just send me a mail if you feel this is the case.
  43
  44 Support/Contact/Documentation
  45 -----------------------------
  46 See the project page, link above.
  47
  48 Have fun!