b04257339b2764e0e49e2c33db014892e834a142
[umurmur.git] / README
1 README for uMurmur - minimalistic Mumble server
2 ===============================================
3 http://code.google.com/p/umurmur/
4
5 Contains protobuf-c library code which is Copyright 2008, Dave Benson.
6 See http://code.google.com/p/protobuf-c/
7
8 uMurmur is available as a precompiled package for some distributions. Check
9 your package repository if you are running OpenWRT or Freetz.
10
11 There are makefiles in the openwrt subdirectory suitable for buildning with
12 the OpenWRT SDK. Move the Makefile of choice to the base directory, e.g.:
13
14 # mv openwrt/Makefile.polarssl Makefile
15
16 and then put the whole umurmur-X.X.X directory in the SDK's 'packages'
17 directory.
18
19
20 Instructions for building from source:
21 1. Requirements
22 o OpenSSL or PolarSSL library
23 o libConfig
24
25 2. Build
26 cd to src directory
27 Might need to edit Makefile
28 make
29
30 3. Install
31 o Copy umurmurd from src directory to where you want it,
32   /usr/local/sbin/ for example.
33 o Edit umurmur.conf.example to your liking and put it in a suitable place.
34   /etc/umurmur.conf is default.
35
36 Some day I might put together an autoconf with the typical configure &&
37 make && make install, but we'll see.
38
39 4. Run
40 As daemon:
41
42 umurmurd -c <conf file> -p <PID file> -r
43
44 For other switches and their meaning run:
45
46 umurmurd -h
47
48 A startup script can easily be created if you want to. Just copy an
49 existing script and edit it to your liking.
50
51 5. Support/Contact/Documentation
52 See the project page, link above.
53
54 Have fun!