blob: 1e6dc655919d58e29e0a388fe1dd47ac91aedb35 [file] [log] [blame]
Brian Waters13d96012017-12-08 16:53:31 -06001See INSTALL file for general instructions on building freeDiameter.
2
3------------------
4QUICK INSTRUCTIONS
5------------------
6
7Starting from version 1.1.5, freeDiameter is available through Homebrew:
8
91) Install Homebrew
10 a) Install Command Line Tools for Xcode or Xcode:
11 - Command Line Tools (your OS X Version) for Xcode:
12 https://developer.apple.com/downloads (Free Apple Developer ID Registration Required)
13 - or Xcode:
14 https://itunes.apple.com/us/app/xcode/id497799835 (Free App Store Account Required)
15
16 b) Install Homebrew
17 $ ruby -e "$(curl -fsSkL raw.github.com/mxcl/homebrew/go)"
18
192) Install freeDiameter:
20 $ brew install freediameter
21
22 After installation is done "Caveats" section will provide information
23 how to start freeDiameterd through launchd at system startup.
24
25 To view this information again:
26 $ brew info freediameter
27
28 To learn more about freeDiameter configuration options, read:
29 http://www.freediameter.net/trac/wiki/Configuration
30
31 For more information on available extension and how to configure them, read:
32 http://www.freediameter.net/trac/wiki/Extensions
33
34------------
35FROM SOURCES
36------------
37
381) Install Homebrew:
39 See QUICK INSTRUCTIONS Step #1 above.
40
412) Install dependencies:
42 $ brew install mercurial cmake gnutls libgcrypt postgres mysql libidn
43
44 Notes:
45 * GNU IDN (libidn) is optional, see below
46 * When libusrsctp package is available, you can use it as well.
47 However, it requires some rework on the source code as libusrsctp is not fully
48 compliant with the other SCTP stack.
49
503) Retrieve source code:
51 $ hg clone http://www.freediameter.net/hg/freeDiameter
52
534) Enter source folder:
54 $ cd freeDiameter
55
565) Create build folder:
57 $ mkdir freeDiameter-build
58
596) Enter build folder:
60 $ cd freeDiameter-build
61
627) Configure:
63 $ cmake .. -DDISABLE_SCTP:BOOL=ON
64
65 or for ncurses-based configuration:
66 $ ccmake .. -DDISABLE_SCTP:BOOL=ON
67
68 Notes:
69 * GNU IDN (Support for International Domain Names) can be disabled with:
70 -DDIAMID_IDNA_IGNORE=ON or -DDIAMID_IDNA_REJECT=ON
71 * For more information on available configuration options, read:
72 http://www.freediameter.net/trac/wiki/Installation
73
748) Compile:
75 $ make
76
779) Install (might require to be root):
78 $ make install
79
80------------------------------------------------
81
82These instructions have been tested on OS X:
83 - 10.6.8 (Snow Leopard)
84 - 10.7.5 (Lion)
85 - 10.8.2 (Mountain Lion)