annotate INSTALL.Ubuntu @ 325:5133b45e3305

Updated documentation
author Sebastien Decugis <sdecugis@nict.go.jp>
date Thu, 20 May 2010 14:23:11 +0900
parents 53f912ce0f4e
children 90294e7e986c
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
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
4 freeDiameter has native support for Debian packaging. All related files
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
5 are in the directory "debian" of the distribution.
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
6
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
7 The following packages are required to compile freeDiameter from source:
234
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
8 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
9
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
10 Additionnaly, these ones may be useful:
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
11 mercurial gdb
290
7842bed901ca Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 234
diff changeset
12
7842bed901ca Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 234
diff changeset
13 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
14
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
15
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
16 If your debhelper environment is recent, the following commands should
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
17 generate the freeDiameter packages for you:
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 # Install the dependencies for building the source:
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
20 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
21
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
22 # Retrieve the latest version of the source package
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
23 cd
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
24 hg clone http://aaa.koganei.wide.ad.jp/hg/freeDiameter
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
25 cd freeDiameter
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
26
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
27 # Build the packages
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
28 fakeroot dh binary
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
29
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
30 # Install the packages
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
31 cd ..
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
32 sudo dpkg -i *.deb
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
33
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
34
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
35 # The following lines may help you getting started.... (execute as root)
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
36 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
37 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
38 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
39 echo "Identity=\"localhost.localdomain\";" >> /etc/freeDiameter/freeDiameter.conf
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
40 freeDiameterd
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
41
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 freeDiameter has been tested on the following distributions:
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
45 Ubuntu Intrepid, Jaunty, Karmic, Lucid.
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
46 Debian Lenny.
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 (Ubuntu Hardy support is broken)
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
49
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
50
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
51 ===========================================-
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
52 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
53
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
54 1) Install all packages dependencies
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
55 # 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
56
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
57 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
58 # sudo apt-get install libpq-dev
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
59
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
60 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
61 # sudo apt-get install cmake-curses-gui
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
62
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
63 4) Retrieve the source files
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
64 # 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
65
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
66 5) Create a build directory, and enter it
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
67 # mkdir fDbuild
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
68 # cd fDbuild
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
69
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
70 6) Configure and generate the Makefiles
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
71 # cmake ../freeDiameter
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
72 # make edit_cache
298
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 7) Compile all files:
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
75 # make
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
76
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
77 8) (OPTION) See available targets:
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
78 # make help
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
79
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
80 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
81 # make test
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 10) Install the software in configured locations:
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
84 # sudo make install
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
85
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
86
311
a45bcbbeac8b Added ready-to-copy instructions
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 304
diff changeset
87 ===========================================
315
2725e68bc78d Tweak init.d scripts
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 313
diff changeset
88
"Welcome to our mercurial repository"