Merge branch 'main' into patch-1

Author: briankwest

.github/workflows/generate-fs-docs.yml

@@ -1,38 +1,27 @@
 name: SignalWire Docs
 
-# Controls when the workflow will run
 on:
-  # Triggers the workflow on push or pull request events but only for the main branch
 
   push:
     branches:
     - main
-    # paths:
-    #   - custom-path/**
+
   pull_request:
     branches:
     - main
 
-  #   paths:
-  #     - custom-path/**
-
-  # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
-  # This workflow contains a single job called "build"
   build:
-    name: "Build/push & deploy to swarm"
-    # The type of runner that the job will run on
-    uses: signalwire/actions-template/.github/workflows/docker-bp.yml@c53f25701311044e264e448672d40cd67d56a7e7
-    with:
-      PROJECT_NAME: "freeswitch-docs"
-      SWARM_SERVICE: "signalwire-docs_freeswitch-docs"
-      PR_MESSAGE: false
-      SWARM_DEPLOY: true
-    secrets:
-      DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
-      DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
-      ENDPOINTID: ${{ secrets.DOCS_ENDPOINT_ID }}
-      PORTAINER_API_KEY: ${{ secrets.PORTAINER_API_KEY }}
+    name: "Build image"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Build image
+        uses: docker/build-push-action@v6
+        with:
+          push: false

.gitignore

@@ -7,6 +7,7 @@
 # Generated files
 .docusaurus
 .cache-loader
+.idea
 
 # Misc
 .DS_Store
@@ -18,3 +19,4 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+

docs/FreeSWITCH-Explained/Installation/Linux/Debian_67240088.mdx

@@ -8,6 +8,12 @@ Authentication required
 SignalWire Personal Access Tokens (PAT)s are required to access FreeSWITCH install packages.  
 [HOWTO Create a SignalWire Personal Access Token](../how-to-create-a-personal-access-token/index.mdx)
 
+## Note for different architectures
+
+This instruction is for amd64 or arm64 (Raspberry Pi 5 64 bit OS for example) - please continue reading.
+
+If your device (or OS) is 32 bit Raspberry Pi (armhf) please use our [Raspberry Pi instruction](https://developer.signalwire.com/freeswitch/FreeSWITCH-Explained/Installation/Raspberry-Pi/)
+
 ## About
 
 FreeSWITCH project has been moved to GitHub: [https://github.com/signalwire/freeswitch](https://github.com/signalwire/freeswitch)  
@@ -228,7 +234,7 @@ cd /usr/src/freeswitch
 make current
 ```
 
-### Build Arcutecture For Packages
+### Build Architecture For Packages
 
 We do not provide packages for 32 bit x86 systems.
 

docs/FreeSWITCH-Explained/Installation/Raspberry-Pi/index.mdx

@@ -5,7 +5,11 @@
 
 ## About
 
-There is no big difference in how to install, build or run FreeSWITCH™ on a Raspberry PI except that we have a special Debian repo for that.
+There is no big difference in how to install, build or run FreeSWITCH™ on a Raspberry PI (armhf) except that we have a special Debian repo for that.
+
+## Note for ARM 64 bit devices
+
+This instruction is for Raspberry Pi 32 bit version (armhf) only! If your device is 64bit (for example Raspberry Pi 5) please use standard [Debian instruction](https://developer.signalwire.com/freeswitch/FreeSWITCH-Explained/Installation/Linux/Debian_67240088)
 
 ## Introduction 
 

docs/FreeSWITCH-Explained/Installation/macOS/index.mdx

@@ -1,5 +1,4 @@
-
-# macOS 
+# macOS
 
 
 
@@ -11,16 +10,25 @@ This is a complete guide for installing FreeSWITCH™ and its prerequisites on m
 **[FreeSWITCH™](http://en.wikipedia.org/wiki/FreeSWITCH)** is an **[application](https://en.wikipedia.org/wiki/Application%5Fsoftware)** that manages **[VOIP](http://en.wikipedia.org/wiki/Voip)** phones and connections to **[ITSPs (Internet Telephony Service Providers)](http://en.wikipedia.org/wiki/ITSP).**
 
 **What Can You Do With FreeSWITCH™?** 
-It's powerful customization provides our incoming calls to do this: Normal ringing is replaced by: “Hi Briana, hold on while our phones ring", phones ring and Briana hears music, after 25 seconds: “hold on Briana while our iPhones ring", internal phones keep ringing and multiple iPhones ring, if no answer: “sorry we missed you Briana, please leave a message", Briana’s voicemail is taken and emailed to multiple iPhones! 
+It's powerful customization provides our incoming calls to do this: Normal ringing is replaced by: “Hi Pam, hold on while our phones ring", phones ring and Pam hears music, after 25 seconds: “hold on Pam while our iPhones ring", internal phones keep ringing and multiple iPhones ring, if no answer: “sorry we missed you Pam, please leave a message", Pam’s voicemail is taken and emailed to multiple iPhones! 
 
 **Who Are These Pages For?** 
 This document is for people who want to install FreeSWITCH™ on macOS and are not familiar with Linux/Unix commands and directories.
 
 **What Is Available on the FreeSWITCH™ macOS Wiki?** 
 Here is a list of the macOS Wiki pages:
 
-| FreeSWITCH™ macOS Installation optionsAutomated installation utilityManual installation using TerminalInstall Homebrew FreeSWITCH versionBasic testing and diagnosing problemsCustomization, tips and screen sharing24x7 operation and automatic restartEmail voicemail files to an iPhoneArchive since 2010 starting with OS X 10.6 | [macOS Installation](./macOS-Installation/index.mdx#about)[macOS macFI Installation](./macOS-Installation/macOS-macFI-Installation_1966731.mdx#about)[macOS Manual Installation](./macOS-Installation/macOS-Manual-Installation_13174557.mdx#about)[macOS Homebrew Installation](./macOS-Installation/macOS-Homebrew-Installation_72253508.mdx#about)[macOS Testing and Diagnostics](./macOS-Testing-and-Diagnostics_13174550.mdx#about)[macOS Customization](./macOS-Customization_9634513.mdx#ssh)[macOS 24x7 Preparation](./macOS-24x7-Preparation_13174585.mdx#about)[macOS Email Voicemail](./macOS-Email-Voicemail_13174591.mdx#about)[MacOS Archive](./MacOS-Archive/index.mdx#about) |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Description | Page |
+| -- | -- |
+| FreeSWITCH™ macOS Installation options | [macOS Installation](./macOS-Installation/index.mdx#about)|
+| Automated installation utility|[macOS macFI Installation](./macOS-Installation/macOS-macFI-Installation_1966731.mdx#about)|
+| Manual installation using Terminal | [macOS Manual Installation](./macOS-Installation/macOS-Manual-Installation_13174557.mdx#about)|
+| Install Homebrew FreeSWITCH version | [macOS Homebrew Installation](./macOS-Installation/macOS-Homebrew-Installation_72253508.mdx#about)|
+| Basic testing and diagnosing problems | [macOS Testing and Diagnostics](./macOS-Testing-and-Diagnostics_13174550.mdx#about)|
+| Customization, tips and screen sharing | [macOS Customization](./macOS-Customization_9634513.mdx#ssh)|
+| 24x7 operation and automatic restart | [macOS 24x7 Preparation](./macOS-24x7-Preparation_13174585.mdx#about)|
+| Email voicemail files to an iPhone | [macOS Email Voicemail](./macOS-Email-Voicemail_13174591.mdx#about)|
+| Archive since 2010 starting with OS X 10.6 | [MacOS Archive](./MacOS-Archive/index.mdx#about) |
 
 
 **How This Documentation Was Developed and Maintained** 
@@ -41,5 +49,3 @@ Major changes occurred:
 * April 28, 2014 - Major updates for new OS X releases and Xcode
 * Mar 21, 2013 - extensively updated and split into multiple pages
 * Nov 22, 2010 - Created initial documentation
-
-

docs/FreeSWITCH-Explained/Installation/macOS/macOS-24x7-Preparation_13174585.mdx

@@ -1,7 +1,6 @@
 
 # macOS 24x7 Preparation 
 
- 
 
 ## About
 
@@ -95,12 +94,9 @@ From the new directory, enter the command below to create the freeswitch.command
   cp dummy.command freeswitch.command
 ```
 
-  
 Open the freeswitch.command file in the editor and replace the two lines with the following bash script:
 
-  
-Click here to view the entire script...
-
+```
 #!/bin/sh
 #set -xv # For debugging
 set -f     # Turn off globbing due to the "*" returned by the netstat command
@@ -186,6 +182,7 @@ writelog "freeswitch-startup - Waiting for FreeSwitch process $pid to terminate"
 while [ $(ps -p $pid -o 'pid=') ]; do sleep 15; done
 writelog "freeswitch-startup - script has ended"
 exit 0
+```
 
 
 Save the file, remember it's already executable. You can use this to manually start FreeSWITCH™ anytime once security has been set.
@@ -602,5 +599,3 @@ If you don't have a UPS, or your UPS runs out of battery power, the Mac will shu
 3. Check "Start up automatically after power failure"
 4. Click UPS
 5. Check "Start up automatically after power failure"
-
-

docs/FreeSWITCH-Explained/Installation/macOS/macOS-Customization_9634513.mdx

@@ -144,5 +144,3 @@ Double clicking the file icons will run Terminal and change the hide/show settin
 ### Show Invisible Files in Open Dialog Window
 
 While any open file dialog window is displayed press command+shift+.(period) to view hidden files. Press again to hide. Note that this does not work in the finder, only for the open dialog box while in an application such as Textedit. 
-
-

docs/FreeSWITCH-Explained/Installation/macOS/macOS-Email-Voicemail_13174591.mdx

@@ -34,19 +34,19 @@ FreeSWITCH™ calls the SENDMAIL program to send voicemail as an email attachmen
 
 Before editing files the correct parameters must be determined. The process is not complicated but getting the settings right for your ISP may take some trial and error. The sample below works if you have your own domain name. You can search the web for "setup email macOS postfix" or "setup outgoing email macOS postfix". Record the following information before editing the configuration files:
 
-smtpdomain - The domain name for the SMTP email server, typically the ISP or your domain name that Freeswitch will use to send email. The example uses mail.abc.com.
+**smtpdomain** - The domain name for the SMTP email server, typically the ISP or your domain name that Freeswitch will use to send email. The example uses mail.abc.com.
 
-smtp port - The port number of the SMTP email server. Common ports: 25, 26, 465, 587, check the ISP. The example uses 465.
+**smtp port** - The port number of the SMTP email server. Common ports: 25, 26, 465, 587, check the ISP. The example uses 465.
 
-myhostname - The qualified domain name of the computer running FreeSWITCH. The example uses imac1.abc.com.
+**myhostname** - The qualified domain name of the computer running FreeSWITCH. The example uses imac1.abc.com.
 
-fromdomain - The domain name of the send email address. The example uses "abc".
+**fromdomain** - The domain name of the send email address. The example uses "abc".
 
-fromname - The email account name of fromdomain the email is sent from. The example uses "freeswitch".
+**fromname** - The email account name of fromdomain the email is sent from. The example uses "freeswitch".
 
-frompw - The password for the fromname email account. The example uses "SECRET".
+**frompw **- The password for the fromname email account. The example uses "SECRET".
 
-toemail - The target complete email address the email to be sent to. The example uses [email protected].
+**toemail** - The target complete email address the email to be sent to. The example uses [email protected].
 
 ## Configuring Postfix
 
@@ -170,12 +170,10 @@ If everyones voicemail are to go to a single common email, you can optionally ma
 
 Edit voicemail.xml and change the line below, make sure to use the valid email account used in the passwords file above:
 
-   Original:      \<param name="email-from" value="$\{voicemail_account}@$\{voicemail_domain}"/>
+   Original:      \<param name="email-from" value="\$\{voicemail_account}@$\{voicemail_domain}"/>
    Replacement:   \<param name="email-from" value="[email protected]"/>
 
 This voicemail templates also required editing. Change the first line in the conf/voicemail.tpl and notify-voicemail.tpl templates:
 
-   Original:      From: "$\{voicemail_caller_id_name}" \<$\{voicemail_caller_id_number}@$\{voicemail_domain}>
+   Original:      From: "\$\{voicemail_caller_id_name}" \<\$\{voicemail_caller_id_number}@\$\{voicemail_domain}>
    Replacement:   From: "$\{voicemail_caller_id_name}" \<[email protected]>
-
-

docs/FreeSWITCH-Explained/Installation/macOS/macOS-Installation/index.mdx

@@ -1,16 +1,10 @@
-
-# macOS Installation 
-
- 
-
 ## About
 
 This page describes FreeSWITCH™ installation methods available for the macOS releases below. It is part of the FreeSWITCH™ [macOS](../index.mdx#about) documentation.  
-\---
 
 * 1 [Installation Methods](#installation-methods)
-* 2 [Build and Testing Status](#build-and-testing-status)
-* 3 [Homebrew Installation](#homebrew-installation)
+* 2 [Homebrew Installation](#homebrew-installation)
+* 3 [Build and Testing Status](#build-and-testing-status)
 * 4 [macOS FreeSWITCH™ Installer (macFI)](#macos-freeswitch-installer-macfi)
 * 5 [Manual Installation](#manual-installation)
 
@@ -22,25 +16,7 @@ FreeSWITCH™ installation on macOS is performed using one of these methods:
 * The [macFI installer utility](#macos-freeswitch-installer-macfi), identical to manual but faster and with installation logs.
 * [Manually](#manual-installation), if you want to build from source and know every detail of the installation.
 
-## Build and Testing Status
-
-This status does _not apply_ to the Homebrew version. Testing is performed on Intel Macs with macOS and the latest Apple Command Line Tools installed into new volumes.
-
-  
- **macOS FreeSWITCH™ Status**
-
-| macOS        | Tested                             | **FreeSWITCH™** V.R.M\*                                  | Status                                                                |
-| ------------ | ---------------------------------- | -------------------------------------------------------- | --------------------------------------------------------------------- |
-| Ventura13.1  | December 15, 2022December 15, 2022 | 1.10.8 Current Public Release1.10.9 20221208 Development | GoodBad [#1840](https://github.com/signalwire/freeswitch/issues/1840) |
-| Monterey12.6 | October 14, 2022October 25, 2022   | 1.10.8 Current Public Release1.10.9 20221024 Development | GoodBad [#1840](https://github.com/signalwire/freeswitch/issues/1840) |
-
-\* Version.Release.Maintenance-Level
-
-History for older releases is at the [macOS Archive](../MacOS-Archive/index.mdx#about).
-
-  
 ---
-
 ## Homebrew Installation
 
 This is the **easiest and fastest way to install FreeSWITCH on macOS.** To perform a Homebrew installation use the [macOS Homebrew Installation](./macOS-Homebrew-Installation_72253508.mdx#about) instructions.
@@ -58,6 +34,24 @@ This is the **easiest and fastest way to install FreeSWITCH on macOS.** To perfo
 * Only provides the current production version.
 * Information on this wiki is limited to testing results since the Homebrew version is maintained independently from this wiki.
 
+---
+## Build and Testing Status
+
+This status does _not apply_ to the Homebrew version. Testing is performed on Intel Macs with macOS and the latest Apple Command Line Tools installed into new volumes.
+
+  
+ **macOS FreeSWITCH™ Status**
+
+| macOS           | Tested                             | **FreeSWITCH™** V.R.M\*                                      | Status |
+|:---------------:|------------------------------------|--------------------------------------------------------------|:------:|
+| Sequoia<br />15.2  | January 2, 2025<br />January 2, 2025 | 1.10.12 Current Public Release<br />1.10.13 20250102 Development | Bad   |
+| Sonoma<br />14.7  | January 2, 2025<br />January 2, 2025 | 1.10.12 Current Public Release<br />1.10.13 20250102 Development | Bad   |
+
+\* Version.Release.Maintenance-Level
+
+History for older releases is at the [macOS Archive](../MacOS-Archive/index.mdx#about).
+
+  
 ---
 
 ## macOS FreeSWITCH™ Installer (macFI)
@@ -82,7 +76,7 @@ The macOS FreeSWITCH™ Installer automates all of the manual steps, providing m
 
 ## Manual Installation
 
-A manual installation requires use of macOS Terminal to enter commands, setup directories, install prerequisites and FreeSWITCH™. To perform a manual installation use the [macOS Manual Installation](./macOS-Manual-Installation_13174557.mdx#about) instructions.
+A manual installation requires use of macOS Terminal to enter commands, setup directories, install prerequisites and FreeSWITCH‚Ñ¢. To perform a manual installation use the [macOS Manual Installation](./macOS-Manual-Installation_13174557.mdx#about) instructions.
 
 **Advantages**
 
@@ -92,11 +86,9 @@ A manual installation requires use of macOS Terminal to enter commands, setup di
 
 **Disadvantages**
 
-* Longest method to install FreeSWITCH™.
+* Longest method to install FreeSWITCH‚Ñ¢.
 * Utilizes more disk space than the Homebrew version.
 * **No Apple Silicon testing for now**.
 
 
 ---
-
-