annotate INSTALL.OSX @ 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 389c26b904d7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
885
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
1 See INSTALL file for general instructions on building freeDiameter.
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
2
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
3 ------------------
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
4 QUICK INSTRUCTIONS
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
5 ------------------
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
6
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
7 Starting from version 1.1.5, freeDiameter is available through Homebrew:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
8
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
9 1) Install Homebrew
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
10 a) Install Command Line Tools for Xcode or Xcode:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
11 - Command Line Tools (your OS X Version) for Xcode:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
12 https://developer.apple.com/downloads (Free Apple Developer ID Registration Required)
887
ad9fe07688b7 freeDiameter package is now available in brews for OSX. Fixed a few cosmetics and typos
Sebastien Decugis <sdecugis@freediameter.net>
parents: 885
diff changeset
13 - or Xcode:
885
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
14 https://itunes.apple.com/us/app/xcode/id497799835 (Free App Store Account Required)
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
15
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
16 b) Install Homebrew
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
17 $ ruby -e "$(curl -fsSkL raw.github.com/mxcl/homebrew/go)"
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
18
887
ad9fe07688b7 freeDiameter package is now available in brews for OSX. Fixed a few cosmetics and typos
Sebastien Decugis <sdecugis@freediameter.net>
parents: 885
diff changeset
19 2) Install freeDiameter:
ad9fe07688b7 freeDiameter package is now available in brews for OSX. Fixed a few cosmetics and typos
Sebastien Decugis <sdecugis@freediameter.net>
parents: 885
diff changeset
20 $ brew install freediameter
885
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
21
887
ad9fe07688b7 freeDiameter package is now available in brews for OSX. Fixed a few cosmetics and typos
Sebastien Decugis <sdecugis@freediameter.net>
parents: 885
diff changeset
22 After installation is done "Caveats" section will provide information
885
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
23 how to start freeDiameterd through launchd at system startup.
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
24
887
ad9fe07688b7 freeDiameter package is now available in brews for OSX. Fixed a few cosmetics and typos
Sebastien Decugis <sdecugis@freediameter.net>
parents: 885
diff changeset
25 To view this information again:
ad9fe07688b7 freeDiameter package is now available in brews for OSX. Fixed a few cosmetics and typos
Sebastien Decugis <sdecugis@freediameter.net>
parents: 885
diff changeset
26 $ brew info freediameter
885
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
27
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
28 To learn more about freeDiameter configuration options, read:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
29 http://www.freediameter.net/trac/wiki/Configuration
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
30
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
31 For more information on available extension and how to configure them, read:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
32 http://www.freediameter.net/trac/wiki/Extensions
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
33
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
34 ------------
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
35 FROM SOURCES
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
36 ------------
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
37
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
38 1) Install Homebrew:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
39 See QUICK INSTRUCTIONS Step #1 above.
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
40
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
41 2) Install dependencies:
1561
699c3fb0c57b Switch from libidn to libidn2.
Thomas Klausner <wiz@gatalith.at>
parents: 1288
diff changeset
42 $ brew install mercurial cmake gnutls libgcrypt postgres mysql libidn2
885
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
43
887
ad9fe07688b7 freeDiameter package is now available in brews for OSX. Fixed a few cosmetics and typos
Sebastien Decugis <sdecugis@freediameter.net>
parents: 885
diff changeset
44 Notes:
1561
699c3fb0c57b Switch from libidn to libidn2.
Thomas Klausner <wiz@gatalith.at>
parents: 1288
diff changeset
45 * GNU IDN (libidn2) is optional, see below
885
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
46 * When libusrsctp package is available, you can use it as well.
1288
389c26b904d7 Added a comment in the OSX file.
Sebastien Decugis <sdecugis@freediameter.net>
parents: 972
diff changeset
47 However, it requires some rework on the source code as libusrsctp is not fully
389c26b904d7 Added a comment in the OSX file.
Sebastien Decugis <sdecugis@freediameter.net>
parents: 972
diff changeset
48 compliant with the other SCTP stack.
885
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
49
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
50 3) Retrieve source code:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
51 $ hg clone http://www.freediameter.net/hg/freeDiameter
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
52
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
53 4) Enter source folder:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
54 $ cd freeDiameter
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
55
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
56 5) Create build folder:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
57 $ mkdir freeDiameter-build
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
58
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
59 6) Enter build folder:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
60 $ cd freeDiameter-build
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
61
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
62 7) Configure:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
63 $ cmake .. -DDISABLE_SCTP:BOOL=ON
887
ad9fe07688b7 freeDiameter package is now available in brews for OSX. Fixed a few cosmetics and typos
Sebastien Decugis <sdecugis@freediameter.net>
parents: 885
diff changeset
64
885
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
65 or for ncurses-based configuration:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
66 $ ccmake .. -DDISABLE_SCTP:BOOL=ON
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
67
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
68 Notes:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
69 * GNU IDN (Support for International Domain Names) can be disabled with:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
70 -DDIAMID_IDNA_IGNORE=ON or -DDIAMID_IDNA_REJECT=ON
887
ad9fe07688b7 freeDiameter package is now available in brews for OSX. Fixed a few cosmetics and typos
Sebastien Decugis <sdecugis@freediameter.net>
parents: 885
diff changeset
71 * For more information on available configuration options, read:
885
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
72 http://www.freediameter.net/trac/wiki/Installation
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
73
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
74 8) Compile:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
75 $ make
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
76
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
77 9) Install (might require to be root):
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
78 $ make install
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
79
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
80 ------------------------------------------------
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
81
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
82 These instructions have been tested on OS X:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
83 - 10.6.8 (Snow Leopard)
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
84 - 10.7.5 (Lion)
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
85 - 10.8.2 (Mountain Lion)
"Welcome to our mercurial repository"