README.md

   1 uMurmur - minimalistic Mumble server
   2 ====================================
   3 Hosted on [GitHub](https://github.com/fatbob313/umurmur)
   4
   5 uMurmur is a minimalistic Mumble server primarily targeted to run on 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 some distributions. Check your package repository if you are running OpenWRT or Freetz.
   6
   7 There are makefiles in the [openwrt](https://github.com/fatbob313/umurmur/tree/master/openwrt) subdirectory suitable for building with the OpenWRT SDK. Move the Makefile of choice to the base directory, e.g.:
   8
   9         mv openwrt/Makefile.polarssl Makefile
  10
  11 and then put the whole umurmur-X.X.X directory in the SDK's 'packages' directory.
  12
  13
  14 Instructions for building from source
  15 -------------------------------------
  16 1. Requirements
  17         * [OpenSSL](http://www.openssl.org/) or [PolarSSL](http://polarssl.org/) library
  18         * [libconfig](http://www.hyperrealm.com/libconfig/)
  19         * [libprotoc-c](http://code.google.com/p/protobuf-c/) version 0.14 (use --disable-protoc option in its ./configure)
  20
  21 2. Build
  22         * `./configure`
  23         * `make`
  24
  25 3. Install
  26         * `make install`
  27         * Edit umurmur.conf.example to your liking and put it in a suitable place. /etc/umurmur.conf is default.
  28
  29 4. Run `umurmurd -c <conf file> -p <PID file> -r`. For other switches and their meaning run `umurmurd -h`
  30
  31 A startup script can easily be created if you want to. Just copy an existing script and edit it to your liking.
  32
  33
  34 Support/Contact/Documentation
  35 -----------------------------
  36 See the project page, link above.
  37
  38 Have fun!