Modified to include macports method
authormbent <mbent@web>
Mon, 21 Dec 2009 14:00:46 +0000 (15:00 +0100)
committerGuus Sliepen <guus@tinc-vpn.org>
Mon, 21 Dec 2009 14:00:46 +0000 (15:00 +0100)
examples/osx-install.mdwn

index abde571..3ea1676 100644 (file)
@@ -3,7 +3,7 @@
 ## Example: installing tinc on Mac OS/X
 
 This example shows how to install and configure tinc on Mac OS X.
-The following was tested on Leopard based system, however should be
+The following was tested on Snow Leopard based system, however should be
 generalisable to other Apple systems as well.  
 This document is intended to give a step-by-step instruction on how
 to install tinc and how to configure it to be used as a basic
@@ -20,7 +20,38 @@ and running properly.
 
 ### Installing tinc
 
-There are two ways of getting tinc:
+The recommended methods to install tinc is by using the macports port system.
+The MacPorts Project is an open-source community initiative to design an easy-to-use system for compiling, installing, and upgrading either command-line, X11 or Aqua based open-source software on the MacOSX operating system.
+Macports is recommended because it does not modify your system files. It keeps itself separate from your system.
+
+#### MacPorts
+
+XCode is a required prerequisite. It must be installed before installing Macports.
+Download and install the Macports system from MacForge.
+
+* [XCode](http://developer.apple.com/technology/Xcode.html) (requires
+  free online ADC Membership); it can also be obtained from original
+  OSX installation DVD
+* [Macports](http://www.macports.org/install.php)
+
+After Macports is installed, close and reopen your terminal.
+Update the ports system and ports list.
+
+    sudo port selfupdate
+    sudo port sync
+
+This command will install tinc and all the necessary dependancies.
+
+    sudo port install tinc
+
+Configuration files are located in /opt/local/etc/tinc.
+
+Tinc can now be configured and executed.
+
+
+### Alternative Installation Methods
+
+There are two alternative methods of getting tinc:
 compiling it or downloading a precompiled binary.
 The second option (download it) - is easier and faster way of
 getting tinc to work.
@@ -29,17 +60,9 @@ getting tinc to work.
 
 In the case of compiling tinc the following is required:
 
-* [XCode](http://developer.apple.com/technology/Xcode.html) (requires
-  free online ADC Membership); it can also be obtained from original
-  OSX installation DVD
+* [XCode](http://developer.apple.com/technology/Xcode.html)
 * [LZO libraries](http://www.oberhumer.com/opensource/lzo/)
 
-It is expected that you know how to install XCode. Moreover, most
-of the operations will be carried using Terminal/Console and thus
-you should be comfortable using some basic commands.   
-The general steps are as follows - install XCode, install LZO,
-install Tinc.  
-
 Before starting, create a new folder `tmp` in your home directory
 and enter it (it can be any other location). From Terminal level it
 can be done in the following way:
@@ -158,4 +181,5 @@ the two existing files (if applicable).
 
 * * * * *
 
-Grzegorz Dymarek (gd58 (at) alumni . st-andrews . ac . uk)
+- Grzegorz Dymarek (gd58 (at) alumni . st-andrews . ac . uk)
+- Mike Bentzen (mike (@) goodlook . com . au)