f5a0226dbb28584a819a8b3b7e2efb8a76991a27
[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 1. Requirements
9 o OpenSSL or PolarSSL library
10 o libConfig
11
12 2. Build
13 cd to src directory
14 Might need to edit Makefile
15 make
16
17 3. Install
18 o Copy umurmurd from src directory to where you want it,
19   /usr/local/sbin/ for example.
20 o Edit umurmur.conf.example to your liking and put it in a suitable place.
21   /etc/umurmur.conf is default.
22
23 Some day I might put together an autoconf with the typical configure &&
24 make && make install, but we'll see.
25
26 4. Run
27 As daemon:
28
29 umurmurd -c <conf file> -p <PID file> -r
30
31 For other switches and their meaning run:
32
33 umurmurd -h
34
35 A startup script can easily be created if you want to. Just copy an
36 existing script and edit it to your liking.
37
38 5. Support/Contact/Documentation
39 See the project page, link above.
40
41 Have fun!