annotate INSTALL.Ubuntu @ 643:f065e3cb846e 1.0.3

Updated documentation
author Sebastien Decugis <sdecugis@nict.go.jp>
date Tue, 21 Dec 2010 10:51:14 +0900
parents 95bb43106039
children a8269458d5b1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
476
47bd114fc55e Updated documentation for Debian/Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 461
diff changeset
1 See http://www.freediameter.net/trac/wiki/DebRepository for instructions on how to
47bd114fc55e Updated documentation for Debian/Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 461
diff changeset
2 install freeDiameter from existing package.
47bd114fc55e Updated documentation for Debian/Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 461
diff changeset
3
47bd114fc55e Updated documentation for Debian/Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 461
diff changeset
4 See INSTALL file for general instructions on building freeDiameter from sources.
234
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
5
476
47bd114fc55e Updated documentation for Debian/Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 461
diff changeset
6 The remaining of this file contains specific instructions for building the freeDiameter
47bd114fc55e Updated documentation for Debian/Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 461
diff changeset
7 package files for Debian and Ubuntu systems.
47bd114fc55e Updated documentation for Debian/Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 461
diff changeset
8
47bd114fc55e Updated documentation for Debian/Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 461
diff changeset
9
47bd114fc55e Updated documentation for Debian/Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 461
diff changeset
10
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
11
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
12 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
13 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
14 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
15 ln -s contrib/debian
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
16
643
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 612
diff changeset
17 ============================================
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
18
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
19 The following packages are required to compile freeDiameter from source:
234
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
20 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
21
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
22 Additionnaly, these ones may be useful:
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
23 mercurial gdb
290
7842bed901ca Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 234
diff changeset
24
612
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
25 Extensions additional dependencies:
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
26 app_acct:
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
27 libpq-dev
234
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
28
612
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
29 app_sip:
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
30 app_diameap:
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
31 libmysqlclient-dev
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
32
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
33 dict_legacy_xml:
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
34 libxml2-dev
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
35
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
36 dbg_interactive:
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
37 swig python-dev
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
38
643
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 612
diff changeset
39 ============================================
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
40
643
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 612
diff changeset
41 If your debhelper environment is recent (> 7.3.9 for cmake support),
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
42 the following commands should generate the freeDiameter packages for you:
325
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 # Install the dependencies for building the source:
612
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
45 sudo apt-get -y install mercurial cmake make gcc bison flex libsctp-dev libgnutls-dev libgcrypt-dev ssl-cert debhelper fakeroot \
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
46 libpq-dev libmysqlclient-dev libxml2-dev swig python-dev
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
47
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
48 # Retrieve the latest version of the source package
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
49 cd
335
603791d2dcc4 Updated website information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 329
diff changeset
50 hg clone http://www.freediameter.net/hg/freeDiameter
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
51 cd freeDiameter
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 # Prepare for Debian package
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
54 ln -s contrib/debian
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
55
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
56 # Build the packages
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
57 fakeroot dh binary
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
58
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
59 # Install the packages
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
60 cd ..
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
61 sudo dpkg -i *.deb
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
62
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
63
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
64 # The following lines may help you getting started.... (execute as root)
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
65 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
66 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
67 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
68 echo "Identity=\"localhost.localdomain\";" >> /etc/freeDiameter/freeDiameter.conf
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
69 freeDiameterd
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
70
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
71 ===========================================
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
72
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
73 freeDiameter has been tested on the following distributions (compiled from source as described bellow):
643
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 612
diff changeset
74 Ubuntu Intrepid, Jaunty, Karmic, Lucid, Maverick, Natty.
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
75 Debian Lenny.
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
76
461
4dc1edb5ddab Added information about app_diameap in the main documentation files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 362
diff changeset
77 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
78
329
b8f85559ba04 Updated doc
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 328
diff changeset
79 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
80
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
81
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
82 ===========================================-
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
83 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
84
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
85 1) Install all packages dependencies
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
86 # 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
87
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
88 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
89 # 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
90 and for mysql:
4dc1edb5ddab Added information about app_diameap in the main documentation files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 362
diff changeset
91 # sudo apt-get install libmysqlclient-dev
298
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 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
94 # sudo apt-get install cmake-curses-gui
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
95
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
96 4) Retrieve the source files
335
603791d2dcc4 Updated website information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 329
diff changeset
97 # 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
98
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
99 5) Create a build directory, and enter it
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
100 # mkdir fDbuild
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
101 # cd fDbuild
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
102
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
103 6) Configure and generate the Makefiles
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
104 # cmake ../freeDiameter
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
105 # make edit_cache
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
106
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
107 7) Compile all files:
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
108 # make
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
109
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
110 8) (OPTION) See available targets:
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
111 # make help
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
112
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
113 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
114 # make test
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
115
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
116 10) Install the software in configured locations:
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
117 # sudo make install
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
118
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
119
311
a45bcbbeac8b Added ready-to-copy instructions
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 304
diff changeset
120 ===========================================
315
2725e68bc78d Tweak init.d scripts
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 313
diff changeset
121
"Welcome to our mercurial repository"