Browse Source

Improved descriptions and markdown formatting (#287)

* Update releases.md

* Update version_upgrade.md

* Update version_upgrade.md

* Update contributing.md

* Update contributing.md

* Update contributing.md

* Update freeswitch.md
Anthony 4 months ago
parent
commit
e266624685

+ 81 - 22
source/additional_information/freeswitch.md

@@ -2,28 +2,35 @@
 
 **Upgrade Move Source**
 
+```
     mv /usr/src/freeswitch freeswitch-version
+```
 
 **Git Release**
 
+```
     cd /usr/src
     git clone -b v1.6 https://freeswitch.org/stash/scm/fs/freeswitch.git
     cd freeswitch
     ./bootstrap.sh
+```
 
 or
 
 **Git Head**
 
+```
     cd /usr/src
     git clone https://freeswitch.org/stash/scm/fs/freeswitch.git
     cd freeswitch
     ./bootstrap.sh
+```
 
 or
 
 **files.freeswitch.org**
 
+```
     cd /usr/src
     wget http://files.freeswitch.org/freeswitch-1.4.26.zip
     unzip freeswitch-1.4.26.zip
@@ -35,90 +42,119 @@ or
     wget http://files.freeswitch.org/freeswitch-1.6.20.zip
     unzip freeswitch-1.6.20.zip
     cd freeswitch-1.6.20
+```
 
 **Ubuntu Dependencies**
 
-    apt-get install autoconf automake devscripts gawk g++ git-core libjpeg-dev libncurses5-dev libtool make python-dev gawk pkg-config libtiff-dev libperl-dev libgdbm-dev libdb-dev gettext libssl-dev libcurl4-openssl-dev libpcre3-dev libspeex-dev libspeexdsp-dev libsqlite3-dev libedit-dev libldns-dev libpq-dev memcached libmemcached-dev
+```
+    apt-get install autoconf automake devscripts gawk g++ git-core libjpeg-dev libncurses5-dev libtool make python-dev gawk pkg-config libtiff-dev libperl-dev libgdbm-dev libdb-dev gettext libssl-dev libcurl4-openssl-dev libpcre3-dev libspeex-dev libspeexdsp-dev libsqlite3-dev libedit-dev libldns-dev libpq-dev           memcached libmemcached-dev
+```
 
 **Debian Dependencies**
 
-    apt-get install autoconf automake devscripts gawk g++ git-core libjpeg-dev libncurses5-dev libtool libtool-bin make python-dev gawk pkg-config libtiff5-dev libperl-dev libgdbm-dev libdb-dev gettext libssl-dev libcurl4-openssl-dev libpcre3-dev libspeex-dev libspeexdsp-dev libsqlite3-dev libedit-dev libldns-dev libpq-dev memcached libmemcached-dev
+```
+    apt-get install autoconf automake devscripts gawk g++ git-core libjpeg-dev libncurses5-dev libtool libtool-bin make python-dev gawk pkg-config libtiff5-dev libperl-dev libgdbm-dev libdb-dev gettext libssl-dev libcurl4-openssl-dev libpcre3-dev libspeex-dev libspeexdsp-dev libsqlite3-dev libedit-dev libldns-dev        libpq-dev memcached libmemcached-dev
+```
 
 **CentOS**
 
+```
     yum install git gcc-c++ autoconf automake libtool wget python ncurses-devel zlib-devel libjpeg-devel openssl-devel e2fsprogs-devel sqlite-devel libcurl-devel pcre-devel speex-devel ldns-devel libedit-devel libmemcached-devel
+```
 
-Configure services to auto start
+- Configure services to auto start
 
+```
     chkconfig --add memcached && chkconfig --levels 33 memcached on
     chkconfig --add freeswitch && chkconfig --levels 35 freeswitch on
+```
 
 **modules.conf**
 
-uncomment the FreeSWITCH modules that are needed.
+- uncomment the FreeSWITCH modules that are needed.
 
+```
     mod_avmd
     mod_callcenter
     mod_memcache
     mod_cidlookup
     mod_curl
     mod_translate
+```
 
-Used for MP3 support
+- Used for MP3 support
 
+```
     mod_shout
+```
 
 **Postgres driver**
 
+```
     ./configure --enable-core-pgsql-support
+```
 
 **Run Make**
 
+```
     make
+```
 
 **Remove FreeSWITCH files**
 
-  This step is only needed for a FreeSWITCH upgrade.
-  Once it has been confirmed that the compile was successful then remove
+- This step is only needed for a FreeSWITCH upgrade.   
+  Once it has been confirmed that the compile was successful then remove   
   files from previous version of FreeSWITCH
 
+```
     rm -rf /usr/local/freeswitch/{lib,mod,bin}/*
+```
 
 **Install**
 
+```
     make install
+```
 
 **File Permissions**
 
-  Set the file permissions instructions may vary based on the OS and
+- Set the file permissions instructions may vary based on the OS and
   install directory.
 
 Debian and Ubuntu
 
+```
     chown -R www-data:www-data /usr/local/freeswitch
+```
 
 CentOS or Other Unix operating systems
-  (need make sure that the web server has access to IVR recordings, Fax,
-  and Voicemail)
 
+- Make sure that the web server has access to IVR recordings, Fax,
+  and Voicemail.
+
+```
     adduser --disabled-password  --quiet --system --home /usr/local/freeswitch --gecos "FreeSWITCH Voice Platform" --ingroup daemon freeswitch
     chown -R freeswitch:daemon /usr/local/freeswitch/ 
-    chmod -R o-rwx /usr/local/freeswitch/
+ chmod -R o-rwx /usr/local/freeswitch/
+```
 
 **Install Sound Files**
 
-Run this on new installs.
+- Run this on new installs.
 
+```
     cd /usr/src/freeswitch
     make sounds-install moh-install
     make hd-sounds-install hd-moh-install
     make cd-sounds-install cd-moh-install
+```
 
 **Startup Script**
 
-  Run on new install only. Create the file \'/etc/init.d/freeswitch\'
+- Run on new install only. Create the file \'/etc/init.d/freeswitch\'
   with the following code:
 
+```
     #!/bin/bash
     ### BEGIN INIT INFO
     # Provides:          freeswitch
@@ -302,11 +338,14 @@ Run this on new installs.
     esac
 
     exit 0
+```
 
-Make the script executable and make it auto start on system boot:
+- Make the script executable and make it auto start on system boot:
 
+```
     chmod +x /etc/init.d/freeswitch
     update-rc.d freeswitch defaults
+```
 
 <br> 
 
@@ -318,31 +357,38 @@ Used to monitor processes on UNIX systems.
 
 ### Install
 
+```
     apt-get install monit
+```
 
-Edit Monit /etc/default/monit and set the \"startup\" variable to 1 in
-order to allow monit to start.
+- Edit Monit /etc/default/monit and set the \"startup\" variable to 1 in
+  order to allow monit to start.
 
 ### Configure
 
 #### Fail2Ban
 
+```
     cd /etc/monit.d
     touch fail2ban
     nano fail2ban
+```
 
-Add the following to the file and save it.
+- Add the following to the file and save it.
 
+```
     check process fail2ban with pidfile /var/run/fail2ban/fail2ban.pid
      group services
      start program = "/etc/init.d/fail2ban start"
      stop  program = "/etc/init.d/fail2ban stop"
      if 5 restarts within 5 cycles then timeout
+```
 
 #### SIP
 
-To monitor SIP from local or remote server
+- To monitor SIP from local or remote server
 
+```
     cd /etc/monit.d
     touch sip
     nano sip
@@ -350,30 +396,36 @@ To monitor SIP from local or remote server
     check host fusionpbx with address your-ip
         if failed port 5060 protocol sip with target monit@monit:5060
             then alert
+```
 
 #### FreeSWITCH
 
+```
     cd /etc/monit/conf.d
+```
 
 or
 
+```
     cd /etc/monit.d
 
     touch freeswitch
     nano freeswitch
+```
 
-Add the following
-
-
+- Add the following
 
+```
     #check process freeswitch with pidfile
     /usr/local/freeswitch/run/freeswitch.pid check process freeswitch
     with pidfile /run/freeswitch/freeswitch.pid start program =
     \"/usr/bin/service freeswitch start\" stop program =
     \"/usr/bin/service freeswitch stop\"
+```
 
 or
 
+```
     #check process freeswitch with pidfile
     /usr/local/freeswitch/run/freeswitch.pid #start program =
     \"/usr/local/freeswitch/bin/./freeswitch -nc -u www-data\" #stop
@@ -381,23 +433,30 @@ or
     process freeswitch with pidfile /run/freeswitch/freeswitch.pid start
     program = \"/usr/bin/./freeswitch -nc -u www-data\" stop program =
     \"/usr/bin/./freeswitch -stop\"
+```
 
 #### Additional Options
 
+```
     if 5 restarts within 5 cycles then timeout
     if cpu > 60% for 2 cycles then alert
     if cpu > 80% for 5 cycles then alert
     if totalmem > 2000.0 MB for 5 cycles then restart
     if children > 2500 then restart
+```
 
-Monit Daemon Add to the main monit config file.
+- Monit Daemon Add to the main monit config file
 
+```
     #monit daemon
     set httpd port 2812 and
     use address localhost
     allow localhost
+```
 
 #### Monit Commands
 
+```
     monit -h
     monit status
+```

+ 24 - 35
source/additional_information/releases.md

@@ -1,37 +1,26 @@
 # Releases
 
-  ----- --------- -------------------
-  GIT   Version   Date
-
-        5.3.0     17 September 2024
-
-        5.2.0     24 January 2024
-
-        5.1.0     15 July 2023
-
-        5.0.1     27 April 2022
-
-        4.4.1     28 May 2018
-
-        4.4.0     5 April 2018
-
-        4.2.2     30 January 2017
-
-        4.2.1     14 December 2016
-
-        4.2.0     11 September 2016
-
-        4.0.0     16 August 2015
-  ----- --------- -------------------
-
-  ------- --------- ---------------
-  SVN     Version   Date
-
-  r6404   3.6       Aug 17, 2014
-
-  r6846   3.6.2     Sept 11, 2014
-
-  r7280   3.6.3     Nov 24, 2014
-
-  r8427   3.8       May 5, 2015
-  ------- --------- ---------------
+### GIT Versions
+
+|   Version   |         Date         |
+| ----------- | -------------------- |
+|    5.3.0    |   17 September 2024  |
+|    5.2.0    |   24 January 2024    |
+|    5.1.0    |   15 July 2023       |
+|    5.0.1    |   27 April 2022      |
+|    4.4.1    |   28 May 2018        |
+|    4.4.0    |   5 April 2018       |
+|    4.2.2    |   30 January 2017    |
+|    4.2.1    |   14 December 2016   |
+|    4.2.0    |   11 September 2016  |
+|    4.0.0    |   16 August 2015     |
+
+
+### SVN Versions    
+  
+|     Version     |        Date      |
+| --------------- | ---------------- |
+|  r6404   3.6    |   Aug 17, 2014   |
+|  r6846   3.6.2  |   Sept 11, 2014  |
+|  r7280   3.6.3  |   Nov 24, 2014   |
+|  r8427   3.8    |   May 5, 2015    |

File diff suppressed because it is too large
+ 338 - 303
source/advanced/version_upgrade.md


+ 10 - 15
source/contributing.md

@@ -2,7 +2,7 @@
 
 There are many ways to help the FusionPBX project.
 
-## What We Need:
+## What We Need
 
 1. Developers
 2. Technical Writers
@@ -10,15 +10,12 @@ There are many ways to help the FusionPBX project.
 4. Quality Assurance Testers
 5. Documentors
 
-:::: note
-<p class="admonition-title">Note</p>
+> **Note:** If you are planning to contribute to any of our GitHub repos, we require that you sign   
+> the FusionPBX Contributor License Agreement. This mainly protects FusionPBX and our users **(read: you)**   
+> from code that could be inserted that might pose a legal problem. It does this by verifying the code you're   
+> contributing is yours to give and that you give it freely and irrevocably to the project.
 
-If you are planning to contribute to any of our GitHub repos, we require that you sign the FusionPBX Contributor License Agreement.
-This mainly protects FusionPBX and our users **(read: you)** from code that could be inserted that might pose a legal problem.
-It does this by verifying that the code you are contributing is yours to give and that you give it freely and irrevocably to the project.
-::::
-
-## How to Get Started:
+## How to Get Started
 
 1. Watch the "FusionPBX Pull Requests with GitHub" YouTube video: [https://youtu.be/SPUe7S4Z6ms](https://youtu.be/SPUe7S4Z6ms)
 
@@ -28,13 +25,11 @@ It does this by verifying that the code you are contributing is yours to give an
 
 2. If you have a good handle on PHP, Lua, or SQL, development might be the thing for you. Head over to the Development Manual.
 3. Are you a FusionPBX power user and do you possibly love to write? Check out the Documentation Guide or the Testing Guide.
-4. Would you like to see FusionPBX in your native language and have the time to commit to staying on top of translations for releases? Check out the translation section to learn how to use our translation server.
+4. Would you like to see FusionPBX in your native language and have the time to commit to staying on top of translations for releases?   
+   Check out the translation section to learn how to use our translation server.
 
-:::: note
-<p class="admonition-title">Note</p>
-Contributing code or documentation requires knowledge of Git, GitHub, and how to create pull requests on GitHub.
-This is not as bad as it sounds, and if you are willing to learn, we will help you through it.
-::::
+> **Note:** Contributing code or documentation requires knowledge of Git, GitHub, and how to create pull requests on GitHub.   
+> This is not as bad as it sounds, and if you are willing to learn, we will help you through it.
 
 ## Table of Contents
 

Some files were not shown because too many files changed in this diff