Mercurial > hg > freeDiameter

annotate INSTALL.OSX @ 876:f8e8cc0d115b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added reference to libusrsctp for OSX
author Sebastien Decugis <sdecugis@freediameter.net>
date Thu, 01 Nov 2012 09:20:10 +0100
parents 27fd6a4ef3f8
children b7002bcc92a5
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
872
27fd6a4ef3f8 Fix typo
Sebastien Decugis <sdecugis@freediameter.net>
parents: 867
diff changeset
28 To learn more about freeDiameter configuration options, read:
867
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:
876
f8e8cc0d115b Added reference to libusrsctp for OSX
Sebastien Decugis <sdecugis@freediameter.net>
parents: 872
diff changeset
39 See QUICK INSTRUCTIONS Step #1 above.
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
40
876
f8e8cc0d115b Added reference to libusrsctp for OSX
Sebastien Decugis <sdecugis@freediameter.net>
parents: 872
diff changeset
41 2) Install dependencies:
867
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
876
f8e8cc0d115b Added reference to libusrsctp for OSX
Sebastien Decugis <sdecugis@freediameter.net>
parents: 872
diff changeset
44 Notes:
f8e8cc0d115b Added reference to libusrsctp for OSX
Sebastien Decugis <sdecugis@freediameter.net>
parents: 872
diff changeset
45 * GNU IDN (libidn) is optional, see bellow
f8e8cc0d115b Added reference to libusrsctp for OSX
Sebastien Decugis <sdecugis@freediameter.net>
parents: 872
diff changeset
46 * When libusrsctp package is available, you can use it as well.
860
0172278ddafe Updated Mac OS X documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 848
diff changeset
47
876
f8e8cc0d115b Added reference to libusrsctp for OSX
Sebastien Decugis <sdecugis@freediameter.net>
parents: 872
diff changeset
48 3) Retrieve source code:
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
49 $ hg clone http://www.freediameter.net/hg/freeDiameter
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
50
876
f8e8cc0d115b Added reference to libusrsctp for OSX
Sebastien Decugis <sdecugis@freediameter.net>
parents: 872
diff changeset
51 4) Enter source folder:
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
52 $ cd freeDiameter
860
0172278ddafe Updated Mac OS X documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 848
diff changeset
53
876
f8e8cc0d115b Added reference to libusrsctp for OSX
Sebastien Decugis <sdecugis@freediameter.net>
parents: 872
diff changeset
54 5) Create build folder:
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
55 $ mkdir freeDiameter-build
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
56
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
57 6) Enter build folder:
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
58 $ cd freeDiameter-build
860
0172278ddafe Updated Mac OS X documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 848
diff changeset
59
876
f8e8cc0d115b Added reference to libusrsctp for OSX
Sebastien Decugis <sdecugis@freediameter.net>
parents: 872
diff changeset
60 7) Configure:
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
61 $ cmake .. -DDISABLE_SCTP:BOOL=ON
876
f8e8cc0d115b Added reference to libusrsctp for OSX
Sebastien Decugis <sdecugis@freediameter.net>
parents: 872
diff changeset
62
f8e8cc0d115b Added reference to libusrsctp for OSX
Sebastien Decugis <sdecugis@freediameter.net>
parents: 872
diff changeset
63 or for ncurses-based configuration:
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
64 $ ccmake .. -DDISABLE_SCTP:BOOL=ON
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
65
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
66 Notes:
876
f8e8cc0d115b Added reference to libusrsctp for OSX
Sebastien Decugis <sdecugis@freediameter.net>
parents: 872
diff changeset
67 * If you have installed libusrsctp, you can turn off the DISABLE_SCTP switch.
f8e8cc0d115b Added reference to libusrsctp for OSX
Sebastien Decugis <sdecugis@freediameter.net>
parents: 872
diff changeset
68 * GNU IDN (Support for International Domain Names) can be disabled with:
f8e8cc0d115b Added reference to libusrsctp for OSX
Sebastien Decugis <sdecugis@freediameter.net>
parents: 872
diff changeset
69 -DDIAMID_IDNA_IGNORE=ON or -DDIAMID_IDNA_REJECT=ON
f8e8cc0d115b Added reference to libusrsctp for OSX
Sebastien Decugis <sdecugis@freediameter.net>
parents: 872
diff changeset
70 * For more information on available configuration options read:
f8e8cc0d115b Added reference to libusrsctp for OSX
Sebastien Decugis <sdecugis@freediameter.net>
parents: 872
diff changeset
71 http://www.freediameter.net/trac/wiki/Installation
860
0172278ddafe Updated Mac OS X documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 848
diff changeset
72
876
f8e8cc0d115b Added reference to libusrsctp for OSX
Sebastien Decugis <sdecugis@freediameter.net>
parents: 872
diff changeset
73 8) Compile:
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
74 $ make
860
0172278ddafe Updated Mac OS X documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 848
diff changeset
75
876
f8e8cc0d115b Added reference to libusrsctp for OSX
Sebastien Decugis <sdecugis@freediameter.net>
parents: 872
diff changeset
76 9) Install (might require to be root):
f8e8cc0d115b Added reference to libusrsctp for OSX
Sebastien Decugis <sdecugis@freediameter.net>
parents: 872
diff changeset
77 $ make install
860
0172278ddafe Updated Mac OS X documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 848
diff changeset
78
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
79 ------------------------------------------------
860
0172278ddafe Updated Mac OS X documentation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 848
diff changeset
80
867
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
81 These instructions have been tested on OS X:
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
82 - 10.6.8 (Snow Leopard)
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
83 - 10.7.5 (Lion)
03d5a7892f2a Improved instructions for Mac OS X
Sebastien Decugis <sdecugis@freediameter.net>
parents: 865
diff changeset
84 - 10.8.2 (Mountain Lion)
"Welcome to our mercurial repository"