Merge branch 'autotools'
[umurmur.git] / README
1 README for uMurmur - minimalistic Mumble server
2 ===============================================
3 http://code.google.com/p/umurmur/
4
5 uMurmur is available as a precompiled package for some distributions. Check
6 your package repository if you are running OpenWRT or Freetz.
7
8 There are makefiles in the openwrt subdirectory suitable for buildning with
9 the OpenWRT SDK. Move the Makefile of choice to the base directory, e.g.:
10
11 # mv openwrt/Makefile.polarssl Makefile
12
13 and then put the whole umurmur-X.X.X directory in the SDK's 'packages'
14 directory.
15
16
17 Instructions for building from source:
18 1. Requirements
19 o OpenSSL or PolarSSL library
20 o libconfig
21 o libprotoc-c (use --disable-protoc option in its ./configure)
22
23 2. Build
24 o ./configure
25 o make
26
27 3. Install
28 o make install
29 o Edit umurmur.conf.example to your liking and put it in a suitable place.
30   /etc/umurmur.conf is default.
31
32 4. Run
33 As daemon:
34 umurmurd -c <conf file> -p <PID file> -r
35
36 For other switches and their meaning run:
37 umurmurd -h
38
39 A startup script can easily be created if you want to. Just copy an
40 existing script and edit it to your liking.
41
42 5. Support/Contact/Documentation
43 See the project page, link above.
44
45 Have fun!