annotate INSTALL.Ubuntu @ 328:90294e7e986c

Moved the debian dir outside the top level directory
author Sebastien Decugis <sdecugis@nict.go.jp>
date Fri, 28 May 2010 17:19:22 +0900
parents 5133b45e3305
children b8f85559ba04
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
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
3
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
4 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
5 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
6 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
7 ln -s contrib/debian
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
8
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
9
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
10 The following packages are required to compile freeDiameter from source:
234
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
11 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
12
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
13 Additionnaly, these ones may be useful:
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
14 mercurial gdb
290
7842bed901ca Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 234
diff changeset
15
7842bed901ca Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 234
diff changeset
16 In order to build app_acct extension, you will also need the package libpq-dev.
234
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
17
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
18
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
19 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
20 the following commands should generate the freeDiameter packages for you:
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
21
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
22 # Install the dependencies for building the source:
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
23 sudo apt-get -y install mercurial cmake make gcc bison flex libsctp-dev libgnutls-dev libgcrypt-dev libpq-dev ssl-cert debhelper fakeroot
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 # Retrieve the latest version of the source package
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
26 cd
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
27 hg clone http://aaa.koganei.wide.ad.jp/hg/freeDiameter
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
28 cd freeDiameter
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
29
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
30 # Prepare for Debian package
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
31 ln -s contrib/debian
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
32
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
33 # Build the packages
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
34 fakeroot dh binary
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
35
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
36 # Install the packages
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
37 cd ..
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
38 sudo dpkg -i *.deb
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
39
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
40
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
41 # The following lines may help you getting started.... (execute as root)
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
42 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
43 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
44 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
45 echo "Identity=\"localhost.localdomain\";" >> /etc/freeDiameter/freeDiameter.conf
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
46 freeDiameterd
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 ===========================================
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
49
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
50 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
51 Ubuntu Intrepid, Jaunty, Karmic, Lucid.
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
52 Debian Lenny.
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
53
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
54 Ubuntu Hardy support is broken.
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
55
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
56 The Debian package has been generated with success on Ubuntu Lucid.
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
57
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
58
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
59 ===========================================-
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
60 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
61
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
62 1) Install all packages dependencies
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
63 # 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
64
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
65 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
66 # sudo apt-get install libpq-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 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
69 # sudo apt-get install cmake-curses-gui
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
70
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
71 4) Retrieve the source files
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
72 # hg clone http://aaa.koganei.wide.ad.jp/hg/freeDiameter
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
73
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
74 5) Create a build directory, and enter it
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
75 # mkdir fDbuild
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
76 # cd fDbuild
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
77
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
78 6) Configure and generate the Makefiles
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
79 # cmake ../freeDiameter
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
80 # make edit_cache
298
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 7) Compile all files:
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
83 # make
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
84
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
85 8) (OPTION) See available targets:
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
86 # make help
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 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
89 # make test
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
90
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
91 10) Install the software in configured locations:
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
92 # sudo make install
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
93
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
94
311
a45bcbbeac8b Added ready-to-copy instructions
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 304
diff changeset
95 ===========================================
315
2725e68bc78d Tweak init.d scripts
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 313
diff changeset
96
"Welcome to our mercurial repository"