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 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
  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         * `./configure`
  18         * `make`
  19
  20 3. Install
  21         * `make install`
  22         * Edit umurmur.conf.example to your liking and put it in a suitable place. /etc/umurmur.conf is default.
  23
  24 4. Run `umurmurd -c <conf file> -p <PID file> -r`. For other switches and their meaning run `umurmurd -h`
  25
  26 A startup script can easily be created if you want to. Just copy an existing script and edit it to your liking.
  27
  28
  29 Support/Contact/Documentation
  30 -----------------------------
  31 See the project page, link above.
  32
  33 Have fun!