annotate INSTALL.OSX @ 867:03d5a7892f2a

Improved instructions for Mac OS X
author Sebastien Decugis <sdecugis@freediameter.net>
date Tue, 30 Oct 2012 20:53:22 +0100
parents debdcc1e03d2
children 27fd6a4ef3f8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
848
6dfa8bc2e71e Added INSTALL.OSX file contributed by Moxie Dee
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff changeset
1 See INSTALL file for general instructions on building freeDiameter.
6dfa8bc2e71e Added INSTALL.OSX file contributed by Moxie Dee
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff changeset
2
6dfa8bc2e71e Added INSTALL.OSX file contributed by Moxie Dee
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff changeset
3 ------------------
6dfa8bc2e71e Added INSTALL.OSX file contributed by Moxie Dee
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff changeset
4 QUICK INSTRUCTIONS
6dfa8bc2e71e Added INSTALL.OSX file contributed by Moxie Dee
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff changeset
5 ------------------
6dfa8bc2e71e Added INSTALL.OSX file contributed by Moxie Dee
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff changeset
6
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
7 Starting from version 1.1.5, freeDiameter is available through Homebrew:
848
6dfa8bc2e71e Added INSTALL.OSX file contributed by Moxie Dee
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff changeset
8
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
9 1) Install Homebrew
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
10 a) Install Command Line Tools for Xcode or Xcode:
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
11 - Command Line Tools (your OS X Version) for Xcode:
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
12 https://developer.apple.com/downloads (Free Apple Developer ID Registration Required)
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
13 - or Xcode:
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
14 https://itunes.apple.com/us/app/xcode/id497799835 (Free App Store Account Required)
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
15
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
16 b) Install Homebrew
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
17 $ ruby -e "$(curl -fsSkL raw.github.com/mxcl/homebrew/go)"
848
6dfa8bc2e71e Added INSTALL.OSX file contributed by Moxie Dee
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff changeset
18
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
19 2) Install freeDiameter
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
20 $ brew install freediameter-server
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
21
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
22 After installation is done "Cavets" section will provide information
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
23 how to start freeDiameterd through launchd at system startup.
848
6dfa8bc2e71e Added INSTALL.OSX file contributed by Moxie Dee
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff changeset
24
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
25 To view this information again:
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
26 $ brew cavets freediameter-server
860
0172278ddafe Updated Mac OS X documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 848
diff changeset
27
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
28 To learn more about freeDiameter configuration option, read:
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
29 http://www.freediameter.net/trac/wiki/Configuration
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
30
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
31 For more information on available extension and how to configure them, read:
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
32 http://www.freediameter.net/trac/wiki/Extensions
860
0172278ddafe Updated Mac OS X documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 848
diff changeset
33
0172278ddafe Updated Mac OS X documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 848
diff changeset
34 ------------
0172278ddafe Updated Mac OS X documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 848
diff changeset
35 FROM SOURCES
0172278ddafe Updated Mac OS X documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 848
diff changeset
36 ------------
0172278ddafe Updated Mac OS X documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 848
diff changeset
37
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
38 1) Install Homebrew:
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
39 See QUICK INSTRUCTION Step #1 above.
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
40
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
41 2) Install Dependencies
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
42 $ brew install mercurial cmake gnutls postgres mysql libidn
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
43
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
44 Note: GNU IDN (libidn) is optional, see bellow
860
0172278ddafe Updated Mac OS X documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 848
diff changeset
45
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
46 3) Retrieve Source
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
47 $ hg clone http://www.freediameter.net/hg/freeDiameter
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
48
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
49 4) Enter Source Folder:
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
50 $ cd freeDiameter
860
0172278ddafe Updated Mac OS X documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 848
diff changeset
51
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
52 5) Create Build Folder:
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
53 $ mkdir freeDiameter-build
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
54
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
55 6) Enter build folder:
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
56 $ cd freeDiameter-build
860
0172278ddafe Updated Mac OS X documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 848
diff changeset
57
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
58 7) Configure
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
59 $ cmake .. -DDISABLE_SCTP:BOOL=ON
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
60 or for ncurses based configuration:
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
61 $ ccmake .. -DDISABLE_SCTP:BOOL=ON
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
62
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
63 Notes:
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
64 * SCTP is not currently supported on OS X platform
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
65 * GNU IDN (Support for International Domain Names) can be disabled with:
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
66 -DDIAMID_IDNA_IGNORE=ON or -DDIAMID_IDNA_REJECT=ON
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
67 * For more information on available configuration options read: http://www.freediameter.net/trac/wiki/Installation
860
0172278ddafe Updated Mac OS X documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 848
diff changeset
68
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
69 8) Compile
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
70 $ make
860
0172278ddafe Updated Mac OS X documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 848
diff changeset
71
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
72 9) Install
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
73 # make install
860
0172278ddafe Updated Mac OS X documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 848
diff changeset
74
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
75 ------------------------------------------------
860
0172278ddafe Updated Mac OS X documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 848
diff changeset
76
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
77 These instructions have been tested on OS X:
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
78 - 10.6.8 (Snow Leopard)
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
79 - 10.7.5 (Lion)
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
80 - 10.8.2 (Mountain Lion)
"Welcome to our mercurial repository"