]> git.ipfire.org Git - thirdparty/freeradius-server.git/commitdiff
minor updates README.md & install_deps.sh - added link , reworded some lines
authornolade <nola.aunger@inkbridge.io>
Thu, 9 Jan 2025 22:07:48 +0000 (17:07 -0500)
committerAlan DeKok <aland@freeradius.org>
Mon, 13 Jan 2025 18:47:52 +0000 (13:47 -0500)
Added details to steps, add hyperlinks, updated layout with headers (TOC)

Remove zip instructions

scripts/osx/README.md
scripts/osx/install_deps.sh

index 5977eeb67634adeea30373c48151f20cc5245a44..311aa3adefa7cb6fb2cd69ee76d054c912c51ae5 100644 (file)
@@ -1,12 +1,13 @@
-# OSX
+# Building on OSX
+FreeRADIUS can be installed on OSX platforms, however some environment setup is required. Additional dev tools are also configured before the server installation.
 
-Install (Homebrew)[https://brew.sh].
+## Environment Setup
 
-Run the `install_deps.sh` script to install the build dependencies.
-You may want to copy it to a local file and remove things you don't
-care about such as postgresql, etc.
+Install the (Homebrew)[https://brew.sh] package manager to streamline the installation process on OSX platforms.
 
-Install Xcode from the app store.
+Run the `install_deps.sh` script to install the build dependencies. It's recommended to create a copy of this file and edit locally. You can remove apps, libs, or utilites that you don't need such as postgresql. Ensure that you use the updated file when running the script.
+
+Install Xcode from the (app store)[https://www.apple.com/ca/app-store/]. This tool is used to help develop, test, and manage your applications.
 
 Install the xcode command-line tools.
 
@@ -14,27 +15,38 @@ Install the xcode command-line tools.
 xcode-select --install
 ```
 
-Update the `~/.zshrc`
+Update the `~/.zshrc` file.
 
 ```
 cat scripts/osx/bash_profile >> ~/.zshrc
 ```
+Note: if using a different shell, ensure you copy the environment paramenters to your current shell.
+
+### Getting the Source
+
+Open a new shell and navigate to the directory where you want to install the FreeRADIUS server.
 
-Open a new shell.
+Download the lastest version from a git repository:
 
 ```
 git clone https://github.com/FreeRADIUS/freeradius-server.git
+```
+
+#### Installation/Configuration
+
+To begin the install process issue the following commands:
+
+```
 cd freeradius-server
 ./configure
 make
 ```
 
+##### Running FreeRADIUS in the background all of the time.
 
-## Running FreeRADIUS in the background all of the time.
-
-You don't need this.  It's here for future reference.
+The information below is for future reference.
 
 ```
 cp ./org.freeradius.radius.plist /Library/LaunchDaemons
 launchctl load -w Library/LaunchDaemons/org.freeradius.radiusd.plist
-```
\ No newline at end of file
+```
index a28c2ffedc446fc77cbd175c8b188c7ccce43ffd..ad25da115421d36b5661c7e9df63dabe4c44ff26 100755 (executable)
@@ -107,7 +107,7 @@ done
 #  and we don't want to allow a partial install of build dependencies, as the
 #  point is to enable the developer to build as many modules as possible.
 #
-#  If they want the dependencies installed they can damn well fix git-lfs support.
+#  If they want the dependencies installed, they need to fix git-lfs support first.
 #
 for i in $packages; do
     if ! brew list "$i" > /dev/null 2>&1; then