Mercurial > hg > freeDiameter

annotate INSTALL.OSX @ 885:b7002bcc92a5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Converted to UNIX line ending
author Sebastien Decugis <sdecugis@freediameter.net>
date Wed, 14 Nov 2012 12:35:47 +0100
parents f8e8cc0d115b
children ad9fe07688b7
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)
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
13 - or Xcode:
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
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
19 2) Install freeDiameter
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
20 $ brew install freediameter-server
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
21
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
22 After installation is done "Cavets" section will provide information
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
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
25 To view this information again:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
26 $ brew cavets freediameter-server
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:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
42 $ brew install mercurial cmake gnutls postgres mysql libidn
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
43
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
44 Notes:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
45 * GNU IDN (libidn) is optional, see bellow
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.
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
47
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
48 3) Retrieve source code:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
49 $ hg clone http://www.freediameter.net/hg/freeDiameter
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
50
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
51 4) Enter source folder:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
52 $ cd freeDiameter
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
53
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
54 5) Create build folder:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
55 $ mkdir freeDiameter-build
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
56
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
57 6) Enter build folder:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
58 $ cd freeDiameter-build
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
59
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
60 7) Configure:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
61 $ cmake .. -DDISABLE_SCTP:BOOL=ON
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
62
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
63 or for ncurses-based configuration:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
64 $ ccmake .. -DDISABLE_SCTP:BOOL=ON
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
65
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
66 Notes:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
67 * If you have installed libusrsctp, you can turn off the DISABLE_SCTP switch.
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
68 * 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
69 -DDIAMID_IDNA_IGNORE=ON or -DDIAMID_IDNA_REJECT=ON
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
70 * For more information on available configuration options read:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
71 http://www.freediameter.net/trac/wiki/Installation
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
72
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
73 8) Compile:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
74 $ make
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
75
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
76 9) Install (might require to be root):
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
77 $ make install
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
78
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 These instructions have been tested on OS X:
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
82 - 10.6.8 (Snow Leopard)
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
83 - 10.7.5 (Lion)
b7002bcc92a5 Converted to UNIX line ending
Sebastien Decugis <sdecugis@freediameter.net>
parents: 876
diff changeset
84 - 10.8.2 (Mountain Lion)
"Welcome to our mercurial repository"