README.md

   1 uMurmur - minimalistic Mumble server
   2 ====================================
   3 Project page on [GoogleCode](http://code.google.com/p/umurmur/)
   4
   5 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.
   6
   7 Instructions for building from source
   8 -------------------------------------
   9 1. Requirements
  10         * [OpenSSL](http://www.openssl.org/) or [PolarSSL](http://polarssl.org/) library. For PolarSSL version 1.0.0 and above is required.
  11         * [libconfig](http://www.hyperrealm.com/libconfig/)
  12         * [libprotoc-c](http://code.google.com/p/protobuf-c/) version 1.0.0 (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.
  13   * [CMake](http://cmake.org) (optional)
  14
  15 2. Build - CMake
  16         * Create a build folder and cd into it
  17         * `cmake ../` to use default settings (polarssl, no test-cert and /dev/urandom as source for randomness).
  18         * `make`
  19
  20 2. Build - Autotools
  21         * Run `./autogen.sh`
  22         * Run `./configure` for default settings
  23         * `make`
  24
  25 3. Install
  26         * `make install`
  27         * Edit the umurmur.conf found in the 'etc' folder in the prefix (eg. /usr/local) you installed to.
  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 Contributors
  34 ------------
  35 * [Antoine Bertin](https://github.com/Diaoul)
  36 * [tilman2](http://code.google.com/u/@UhZTSlBWAxNMWgU%3D/)
  37 * J Sisson - sisson.j ( AT ) gmail DOT com
  38 * [pierre.h](http://code.google.com/u/@VBRUQ1ZTAhNEXwJ9/)
  39 * [phr0z3nt04st](https://github.com/phr0z3nt04st)
  40 * [Troy C](https://github.com/troxor)
  41 * [Trivve](https://github.com/Trivve)
  42 * [hasufell](https://github.com/hasufell)
  43 * [fmorgner](https://github.com/fmorgner)
  44 * [Rawi666](https://github.com/Rawi666)
  45 * [snowblind](https://github.com/snowblind)
  46
  47 Hope I didn't forget anyone... Please just send me a mail if you feel this is the case.
  48
  49 Support/Contact/Documentation
  50 -----------------------------
  51 See the project page, link above.
  52
  53 Have fun!