annotate INSTALL.Ubuntu @ 1561:699c3fb0c57b

Switch from libidn to libidn2. libidn2 is the backwards compatible successor to libidn, and at least Red Hat 8 does not provide a dev package for libidn1.
author Thomas Klausner <wiz@gatalith.at>
date Wed, 16 Jun 2021 18:44:45 +0200
parents e6b14a15d5f2
children
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:
1561
699c3fb0c57b Switch from libidn to libidn2.
Thomas Klausner <wiz@gatalith.at>
parents: 1351
diff changeset
20 cmake make gcc g++ flex bison libsctp1 libsctp-dev libgnutls-dev libgcrypt-dev libidn2-dev
707
e387d5c6b6f5 Added support for Internationalized Domain Names (IDNA) using GNU libidn
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 660
diff changeset
21
1561
699c3fb0c57b Switch from libidn to libidn2.
Thomas Klausner <wiz@gatalith.at>
parents: 1351
diff changeset
22 (note that libidn2 and libsctp can be avoided by defining DISABLE_SCTP and DIAMID_IDNA_REJECT)
234
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
23
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
24 Additionnaly, these ones may be useful:
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
25 mercurial gdb
290
7842bed901ca Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 234
diff changeset
26
612
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
27 Extensions additional dependencies:
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
28 app_acct:
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
29 libpq-dev
234
f91fe0b85928 Updated INSTALL files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
30
612
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
31 app_sip:
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
32 app_diameap:
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
33 libmysqlclient-dev
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
34
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
35 dict_legacy_xml:
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
36 libxml2-dev
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
37
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
38 dbg_interactive:
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
39 swig python-dev
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
40
643
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 612
diff changeset
41 ============================================
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
42
643
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 612
diff changeset
43 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
44 the following commands should generate the freeDiameter packages for you:
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
45
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
46 # Install the dependencies for building the source:
1561
699c3fb0c57b Switch from libidn to libidn2.
Thomas Klausner <wiz@gatalith.at>
parents: 1351
diff changeset
47 sudo apt-get -y install mercurial cmake make gcc g++ bison flex libsctp-dev libgnutls-dev libgcrypt-dev libidn2-dev ssl-cert debhelper fakeroot \
612
95bb43106039 Updated documentation, included information for OpenSUSE and Fedora
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
48 libpq-dev libmysqlclient-dev libxml2-dev swig python-dev
1351
e6b14a15d5f2 Updated comments for Ubuntu Bionic
Sebastien Decugis <sdecugis@freediameter.net>
parents: 1011
diff changeset
49
e6b14a15d5f2 Updated comments for Ubuntu Bionic
Sebastien Decugis <sdecugis@freediameter.net>
parents: 1011
diff changeset
50 # On latest Ubuntu you will need libgnutls28-dev instead of libgnutls-dev
325
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 # Retrieve the latest version of the source package
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
53 cd
335
603791d2dcc4 Updated website information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 329
diff changeset
54 hg clone http://www.freediameter.net/hg/freeDiameter
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
55 cd freeDiameter
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
56
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
57 # Prepare for Debian package
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
58 ln -s contrib/debian
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
59
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
60 # Build the packages
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
61 fakeroot dh binary
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 # Install the packages
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
64 cd ..
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
65 sudo dpkg -i *.deb
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
66
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
67
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
68 # The following lines may help you getting started.... (execute as root)
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
69 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
70 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
71 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
72 echo "Identity=\"localhost.localdomain\";" >> /etc/freeDiameter/freeDiameter.conf
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
73 freeDiameterd
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
74
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
75 ===========================================
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
76
1011
aaf8743df5e7 Updated Ubuntu documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 972
diff changeset
77 freeDiameter is tested regularly on all current Ubuntu distributions since Intrepid (compiled from source as described below)
461
4dc1edb5ddab Added information about app_diameap in the main documentation files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 362
diff changeset
78 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
79
329
b8f85559ba04 Updated doc
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 328
diff changeset
80 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
81
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 ===========================================-
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
84 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
85
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
86 1) Install all packages dependencies
1561
699c3fb0c57b Switch from libidn to libidn2.
Thomas Klausner <wiz@gatalith.at>
parents: 1351
diff changeset
87 # sudo apt-get install mercurial cmake make gcc g++ bison flex libsctp-dev libgnutls-dev libgcrypt-dev libidn2-dev
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
88
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
89 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
90 # 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
91 and for mysql:
4dc1edb5ddab Added information about app_diameap in the main documentation files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 362
diff changeset
92 # sudo apt-get install libmysqlclient-dev
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
93
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
94 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
95 # sudo apt-get install cmake-curses-gui
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
96
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
97 4) Retrieve the source files
335
603791d2dcc4 Updated website information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 329
diff changeset
98 # 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
99
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
100 5) Create a build directory, and enter it
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
101 # mkdir fDbuild
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
102 # cd fDbuild
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
103
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
104 6) Configure and generate the Makefiles
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
105 # cmake ../freeDiameter
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
106 # make edit_cache
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
107
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
108 7) Compile all files:
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
109 # make
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
110
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
111 8) (OPTION) See available targets:
298
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
112 # make help
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
113
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
114 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
115 # make test
57b671bc5e8d Added detailed instructions for Ubuntu
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 290
diff changeset
116
1011
aaf8743df5e7 Updated Ubuntu documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 972
diff changeset
117 10) (OPTION) Install the software in configured locations:
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
118 # sudo make install
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 320
diff changeset
119
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
120
311
a45bcbbeac8b Added ready-to-copy instructions
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 304
diff changeset
121 ===========================================
315
2725e68bc78d Tweak init.d scripts
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 313
diff changeset
122
877
e815a8cfca4b Added a note for Quantal Quetzal
Sebastien Decugis <sdecugis@freediameter.net>
parents: 707
diff changeset
123 Note: On Ubuntu Quantal Quetzal, you may have to force use of python 2.7
e815a8cfca4b Added a note for Quantal Quetzal
Sebastien Decugis <sdecugis@freediameter.net>
parents: 707
diff changeset
124 library for the dbg_interactive extension, as on some systems CMake selects the 3.2 library
e815a8cfca4b Added a note for Quantal Quetzal
Sebastien Decugis <sdecugis@freediameter.net>
parents: 707
diff changeset
125 by default.
"Welcome to our mercurial repository"