Mercurial > hg > freeDiameter

annotate INSTALL.Ubuntu @ 461:4dc1edb5ddab

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added information about app_diameap in the main documentation files
author Sebastien Decugis <sdecugis@nict.go.jp>
date Fri, 30 Jul 2010 11:40:00 +0900
parents 5b199400a290
children 47bd114fc55e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
234
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
1 See INSTALL file for general instructions on building freeDiameter.
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
2
329
b8f85559ba04 Updated doc
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 328
diff changeset
3 This file contains specific instructions to compile and install freeDiameter
b8f85559ba04 Updated doc
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 328
diff changeset
4 on Debian and Ubuntu systems.
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
5
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
6 freeDiameter is shipped with the necessary files to generate the Debian package.
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
7 All related files are in the directory "contrib/debian" of the distribution.
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
8 As a first step, you have to link this directory from your top-level dir:
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
9 ln -s contrib/debian
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
10
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
11
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
12 The following packages are required to compile freeDiameter from source:
234
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
13 cmake make gcc flex bison libsctp1 libsctp-dev libgnutls-dev libgcrypt-dev
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
14
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
15 Additionnaly, these ones may be useful:
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
16 mercurial gdb
290
7842bed901ca Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 234
diff changeset
17
7842bed901ca Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 234
diff changeset
18 In order to build app_acct extension, you will also need the package libpq-dev.
461
4dc1edb5ddab Added information about app_diameap in the main documentation files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 362
diff changeset
19 In order to build app_sip or app_diameap extension, you will also need the package libmysqlclient-dev.
234
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
20
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
21
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
22 If your debhelper environment is recent (> 7.3.9 to provide cmake support),
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
23 the following commands should generate the freeDiameter packages for you:
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
24
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
25 # Install the dependencies for building the source:
461
4dc1edb5ddab Added information about app_diameap in the main documentation files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 362
diff changeset
26 sudo apt-get -y install mercurial cmake make gcc bison flex libsctp-dev libgnutls-dev libgcrypt-dev libpq-dev libmysqlclient-dev ssl-cert debhelper fakeroot
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
27
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
28 # Retrieve the latest version of the source package
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
29 cd
335
603791d2dcc4 Updated website information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 329
diff changeset
30 hg clone http://www.freediameter.net/hg/freeDiameter
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
31 cd freeDiameter
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
32
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
33 # Prepare for Debian package
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
34 ln -s contrib/debian
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
35
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
36 # Build the packages
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
37 fakeroot dh binary
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
38
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
39 # Install the packages
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
40 cd ..
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
41 sudo dpkg -i *.deb
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
42
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
43
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
44 # The following lines may help you getting started.... (execute as root)
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
45 ln -s /etc/ssl/certs/ssl-cert-snakeoil.pem /etc/ssl/certs/freeDiameter.pem
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
46 ln -s /etc/ssl/private/ssl-cert-snakeoil.key /etc/ssl/private/freeDiameter.key
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
47 zcat /usr/share/doc/freediameter-daemon/examples/freediameter.conf.sample.gz > /etc/freeDiameter/freeDiameter.conf
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
48 echo "Identity=\"localhost.localdomain\";" >> /etc/freeDiameter/freeDiameter.conf
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
49 freeDiameterd
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
50
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
51 ===========================================
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
52
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
53 freeDiameter has been tested on the following distributions (compiled from source as described bellow):
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
54 Ubuntu Intrepid, Jaunty, Karmic, Lucid.
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
55 Debian Lenny.
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
56
461
4dc1edb5ddab Added information about app_diameap in the main documentation files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 362
diff changeset
57 Ubuntu Hardy support is known to be broken.
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
58
329
b8f85559ba04 Updated doc
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 328
diff changeset
59 The Debian package has been generated with success on Debian (>=Squeeze) and Ubuntu (>=Karmic).
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
60
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
61
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
62 ===========================================-
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
63 Step by step instructions without using the debhelper tools:
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
64
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
65 1) Install all packages dependencies
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
66 # sudo apt-get install mercurial cmake make gcc bison flex libsctp-dev libgnutls-dev libgcrypt-dev
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
67
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
68 2) (OPTION) If you will compile modules that require postgresql, also install:
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
69 # sudo apt-get install libpq-dev
461
4dc1edb5ddab Added information about app_diameap in the main documentation files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 362
diff changeset
70 and for mysql:
4dc1edb5ddab Added information about app_diameap in the main documentation files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 362
diff changeset
71 # sudo apt-get install libmysqlclient-dev
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
72
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
73 3) (OPTION) If you want a more user-friendly interface, install this:
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
74 # sudo apt-get install cmake-curses-gui
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
75
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
76 4) Retrieve the source files
335
603791d2dcc4 Updated website information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 329
diff changeset
77 # hg clone http://www.freediameter.net/hg/freeDiameter
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
78
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
79 5) Create a build directory, and enter it
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
80 # mkdir fDbuild
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
81 # cd fDbuild
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
82
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
83 6) Configure and generate the Makefiles
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
84 # cmake ../freeDiameter
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
85 # make edit_cache
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
86
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
87 7) Compile all files:
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
88 # make
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
89
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
90 8) (OPTION) See available targets:
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
91 # make help
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
92
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
93 9) (OPTION) Check the software has a correct basic behavior on your environment. -- only if you did not disable the tests in step 6
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
94 # make test
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
95
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
96 10) Install the software in configured locations:
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
97 # sudo make install
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
98
304
ad3c46016584 Added install directives for cmake; also allow default directory to seek for extensions and configuration files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 298
diff changeset
99
311
a45bcbbeac8b Added ready-to-copy instructions
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 304
diff changeset
100 ===========================================
315
2725e68bc78d Tweak init.d scripts
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 313
diff changeset
101
"Welcome to our mercurial repository"