Content/images added, updated. Fixed formatting. (#141)

* Update freeswitch.rst * Create software_utilities.rst * Update software_utilities.rst * Update additional_information.rst * Update software_utilities.rst * Update software_utilities.rst * image add * Update extensions.rst * image add * image change * Update devices.rst * image add * Update providers.rst * Update destinations.rst * Update outbound_routes.rst * Update outbound_routes.rst * Update outbound_routes.rst * Update outbound_routes.rst * Update call_detail_record.rst * Update call_detail_record.rst * Update call_detail_record.rst * Update call_routing.rst * image add * image add * Update conference.rst * image add * Update conference_center.rst * Update conference_center.rst * Update conference_controls.rst * Update conference.rst * image add * Update conference_center.rst * Update conference_center.rst
fusionpbx · Jul 12, 2018 · f313c9a · f313c9a
1 parent 7019772
commit f313c9a
Show file tree

Hide file tree

Showing 21 changed files with 306 additions and 60 deletions.
diff --git a/source/_static/images/accounts/fusionpbx_accounts_extensions.jpg b/source/_static/images/accounts/fusionpbx_accounts_extensions.jpg
diff --git a/source/_static/images/applications/conference/fusionpbx_conference_add.jpg b/source/_static/images/applications/conference/fusionpbx_conference_add.jpg
diff --git a/source/_static/images/applications/conference/fusionpbx_conferences.jpg b/source/_static/images/applications/conference/fusionpbx_conferences.jpg
diff --git a/source/_static/images/applications/fusionpbx_conference_center_add.jpg b/source/_static/images/applications/fusionpbx_conference_center_add.jpg
diff --git a/source/_static/images/applications/fusionpbx_conference_center_rooms.jpg b/source/_static/images/applications/fusionpbx_conference_center_rooms.jpg
diff --git a/source/_static/images/applications/fusionpbx_conference_center_rooms_settings.jpg b/source/_static/images/applications/fusionpbx_conference_center_rooms_settings.jpg
diff --git a/source/_static/images/devices/fusionpbx_accounts_devices_profiles.jpg b/source/_static/images/devices/fusionpbx_accounts_devices_profiles.jpg
diff --git a/source/_static/images/devices/fusionpbx_accounts_devices_vendors.jpg b/source/_static/images/devices/fusionpbx_accounts_devices_vendors.jpg
diff --git a/source/accounts/devices.rst b/source/accounts/devices.rst
@@ -23,3 +23,24 @@ Used to define the information needed to assign SIP accounts and keys to provisi
         :scale: 85%
 
 * To view steps on how to configure other devices to provision `click here for the provisioning section <http://docs.fusionpbx.com/en/latest/applications/provision.html>`_.
+
+
+Device Vendors
+----------------
+
+Vendors can be added or removed to help fine tune the devices page when configuring specific vendor phones.
+
+.. image:: ../_static/images/devices/fusionpbx_accounts_devices_vendors.jpg
+        :scale: 85%
+
+
+Profiles
+----------
+
+Define a set of keys as a profile. Any changes to the profile effect all devices assigned to the profile. 
+
+
+
+.. image:: ../_static/images/devices/fusionpbx_accounts_devices_profiles.jpg
+        :scale: 85%
+
diff --git a/source/accounts/extensions.rst b/source/accounts/extensions.rst
@@ -2,7 +2,13 @@
 Extensions
 ************
 
-| The **Extensions** define the information needed for an endpoint such as a hard phone, soft phone or some other device to connect to the SIP server. The extension is the SIP username, the password is the secret used for authentication and the domain name servers to purposes it locates the server to register to and is the realm that determines which domain the endpoint is registering to.
+**Extensions** define the information needed for an endpoint such as a hard phone, soft phone or some other device to connect to the SIP server. The extension is the SIP username and the password is the secret used for authentication. The domain name servers (DNS) to purposes it, locates the server to register to and is the realm that determines which domain the endpoint is registering to.
+
+
+.. image:: ../_static/images/accounts/fusionpbx_accounts_extensions.jpg
+        :scale: 85%
+
+
 
 *  Extension 	
     Enter the alphanumeric extension. The default configuration allows 2 - 7 digit extensions.

diff --git a/source/accounts/providers.rst b/source/accounts/providers.rst
@@ -2,7 +2,7 @@
 Providers
 ************
 
-(Master Branch) List of VoIP providers that support FusionPBX.  This feature provides a simple and fast way to add gateways, outbound routes and access control lists that will enable calls through the carrier to the public switched telephone network (PSTN).
+List of VoIP providers that support FusionPBX.  This feature provides a simple and fast way to add gateways, outbound routes and access control lists that will enable calls through the carrier to the public switched telephone network (PSTN).
 
 
 .. image:: ../_static/images/accounts/fusionpbx_providers_voicetel.jpg
@@ -14,3 +14,8 @@ Providers
         :scale: 85%
         :target: http://skye.tel/fusion-contact
 
+
+.. note::
+
+      If you would like your carrier to be included in this section, please reach out to support@fusionpbx.com to discuss how.
+
diff --git a/source/additional_information.rst b/source/additional_information.rst
@@ -26,3 +26,5 @@ Additional Information
   additional_information/releases.rst
   additional_information/regex.rst
   additional_information/postgresql.rst
+  getting_started/software_utilities.rst
+
diff --git a/source/additional_information/freeswitch.rst b/source/additional_information/freeswitch.rst
@@ -354,4 +354,108 @@ Make the script executable and make it auto start on system boot:
  update-rc.d freeswitch defaults
 
 |
+
+
+Monit
+------
+
+Used to monitor processes on UNIX systems.
+
+http://mmonit.com/monit/ 
+
+
+Install
+^^^^^^^^^
+
+::
+
+ apt-get install monit
+
+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.
+
+::
+
+ 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
+
+FreeSWITCH
+~~~~~~~~~~~~
+
+::
+
+ cd /etc/monit/conf.d
+
+or
+
+::
+
+ cd /etc/monit.d
+
+ touch freeswitch
+ nano freeswitch
+
+Add the following
+
+::
+
+ check process freeswitch with pidfile /usr/local/freeswitch/run/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 program  = "/usr/local/freeswitch/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
+ set httpd port 2812 and
+ use address localhost
+ allow localhost
+
+Monit Commands
+~~~~~~~~~~~~~~~
+
+::
+
+ monit -h
+ monit status
+
+
+
+
diff --git a/source/applications/call_detail_record.rst b/source/applications/call_detail_record.rst
@@ -68,37 +68,35 @@ Possible causes:
 
 **1. The module is disabled**
 
-| ``- Older installations of FusionPBX had the CDR CSV module enabled and the XML CDR module disabled.``
-| ``- If you reverse this situation you will then get call detail records.  You will also need to start``
-| ``the XML CDR module after you have done this.  Note that if you want to see your old CDR CSV records, ``
-| ``after the change, or you really want to continue using CDR CSV you can go to Menu Manager and unhide ``
-| ``the CDR CSV menu.``
-
-| ``Note that call recordings can be downloaded from the Call Detail Records page, but this capability is ``
-| ``not currently provided in CDR CSV - so if you need to use call recordings it would be better to use ``
-| ``XML CDR.``
+- Older installations of FusionPBX had the CDR CSV module enabled and the XML CDR module disabled.
+- If you reverse this situation you will then get call detail records.  You will also need to start the XML CDR module after you have done this.  
+- If you want to see your old CDR CSV records after the change or you really want to continue using CDR CSV you can go to Menu Manager and unhide the CDR CSV menu.
+- Call recordings can be downloaded from the Call Detail Records page, but this capability is not currently provided in CDR CSV so if you need to use call recordings it would be better to use XML CDR.
 
 **2. Wrong xml_cdr.conf.xml config**
 
-``- check ``\ **\ **\ ```http://localhost/mod/xml_cdr/v_xml_cdr_import.php```_\ **\ \ ``"/>``**\ `` and adapt it to your situation.``
-
-FusionPBX menu bar disappears under certain circumstances when viewing Call Detail Records
+- check <param name="url" value="http://127.0.0.1/app/xml_cdr/v_xml_cdr_import.php"/> and adapt it to your situation.
 
-If this happens to you it may be because you are using an old version of xml_cdr.conf.xml
+- FusionPBX menu bar disappears under certain circumstances when viewing Call Detail Records
+    - If this happens to you it may be because you are using an old version of xml_cdr.conf.xml
 
-Compare your version (advanced-script editor-files-autoload_configs-xml_cdr.conf.xml) with the current default one that is included in FusionPBX (advanced-php editor-files-includes-templates-conf-autoload_configs-xml_cdr.conf.xml). If it is different copy the default one over yours. Then edit the line <param name="url" value="http://{v_domain}/mod/xml_cdr/v_xml_cdr_import.php"/> and replace {v_domain} with the domain or IP address of your FusionPBX server. Then edit the line <param name="cred" value="{v_user}:{v_pass}"/> and replace {v_user} with a complex name of upper and lowercase and numeric characters so it is really ugly and secure, and do the same for v_pass - make each of them completely unique. Note that these don't have to match anything else on your server at all - this is because FusionPBX does something very simple but clever here - the xml_cdr module uses this account when it does an http post to FusionPBX of the new data, but FusionPBX looks at the same xml_cdr.conf.xml file that the module uses in order to check if the module is using a valid account and password - so since they both look at the same config file they are using the same account and password and will happily talk to each other!
+* Compare your version (advanced-script editor-files-autoload_configs-xml_cdr.conf.xml) with the current default one that is included in FusionPBX (advanced-php editor-files-includes-templates-conf-autoload_configs-xml_cdr.conf.xml). If it is different copy the default one over yours.
+* Then edit the line <param name="url" value="http://{v_domain}/mod/xml_cdr/v_xml_cdr_import.php"/> and replace {v_domain} with the domain or IP address of your FusionPBX server.
+* Then edit the line <param name="cred" value="{v_user}:{v_pass}"/> and replace {v_user} with a complex name of upper and lowercase and numeric characters so it is really ugly and secure, and do the same for v_pass.
+* Make each of them completely unique.
+* Be aware that these don't have to match anything else on your server at all.  This is because FusionPBX does something very simple but clever here.  The xml_cdr module uses this account when it does an http post to FusionPBX of the new data.  FusionPBX looks at the same xml_cdr.conf.xml file that the module uses in order to check if the module is using a valid account and password.  Since they both look at the same config file they are using the same account and password and will happily talk to each other!
 
-Once you've made these changes you can save the file. You could restart your server, or you could reloadxml and then restart the xml_cdr module - either is ok - it is up to you. And then your changes will have taken effect and you should no longer lose your menu bar when looking at CDR information. 
+Once you've made these changes you can save the file. You could restart your server, or you could reloadxml and then restart the xml_cdr module.  Either is ok, it is up to you. Then your changes will have taken effect and you should no longer lose your menu bar when looking at CDR information. 
 
 XML CDR configuration
 ~~~~~~~~~~~~~~~~~~~~~
 
 For more detailed configuration go to the XML editor (Advanced menu) and
 in autoload configs look at xml_cdr.conf.xml
 
-| ``- note that by default only the a-leg of the call is logged therefore if you make a recording of ``
-| ``the b-leg you won't be able to retrieve it using the Call Detail Records.  If you want the b-leg``
-| ``as well you need to change log-b-leg=true in this config.``
+.. note::
+       
+ By default only the a-leg of the call is logged therefore if you make a recording of the b-leg you won't be able to retrieve it using the Call Detail Records.  If you want the b-leg as well you need to change log-b-leg=true in this config.
 
 Harddrive space usage
 ~~~~~~~~~~~~~~~~~~~~~

diff --git a/source/applications/call_routing.rst b/source/applications/call_routing.rst
@@ -15,8 +15,8 @@ Directs incoming calls for the extension
 *  Click **CALL ROUTING** on the top right
 
 
-Note about Call Forward and Do No Disturb
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Call Forward and Do No Disturb
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 This will allow phones to sync CFWD and DND over SIP.
 

diff --git a/source/applications/conference.rst b/source/applications/conference.rst
@@ -7,14 +7,39 @@ Conferences is used to setup conference rooms with a name, description, and opti
 .. note::  For advanced conferencing use Apps -> Conference Center
 
 
-.. image:: ../_static/images/fusionpbx_conferences.jpg
+.. image:: ../_static/images/applications/conference/fusionpbx_conferences.jpg
         :scale: 85%
 
 
-Enable Conference
-==================
+Conference Settings
+--------------------
 
-By default Conferences are hidden from the menu.
+.. image:: ../_static/images/applications/conference/fusionpbx_conference_add.jpg
+        :scale: 85%
+
+
+* **Name:** Name for the conference. 
+* **Extension:** The number for the extension the user will dial.(Be sure it doesn't exist before creating it.)
+* **Pin Number:** If you want to add a layer of security to enter the conference.
+* **Profile:**
+   - Default- The default audio quality rate and video.
+   - wait-mod- Wait Mod setting.
+   - wideband- Wideband audio quality rate and video.
+   - ultra-wideband- Ultra wideband quality rate and video.
+   - cdquality- CD Quality rate and video.
+   - page- Page setting.
+
+* **Flags:** mute|deaf|waste|moderator (Other values are available also)
+* **Order:** The order of the conference.
+* **Enabled:** If the conference is enabled.
+* **Description:** A way to organize what the conference purpose is.
+
+
+
+Enable Conferences
+---------------------
+
+By default Conferences use to be hidden from the menu.
 
 *  To add Conferences to the menu goto **Advanced > Menu Manager** and click the pencil edit icon on the right
 *  Then click the pencil edit icon on the right of **Conferences**

diff --git a/source/applications/conference_center.rst b/source/applications/conference_center.rst
@@ -15,3 +15,43 @@ Conference Centers are a group of conference rooms. They can be organized by cos
 *  To view rooms click the **ROOMS** at the top right.
 
 .. note::  For basic conferencing use Apps -> Conferences
+
+
+Conference Center Options
+---------------------------
+
+
+.. image:: ../_static/images/applications/fusionpbx_conference_center_add.jpg
+        :scale: 85%
+
+
+* **Name:** Name of the Conference Center.
+* **Extension:** Extension of the Conference Center. (Be sure to not use an extension already in use)
+* **Greeting:** Choose a greeting to play.
+* **PIN Length:** Add a layer of security for entering the Conference Center.
+* **Enabled:** Enable or disable the Conference Center.
+* **Description:** A way to organize what the Conference Center is for.
+
+
+Conference Center Rooms
+-------------------------
+
+Apps > Conference Center > Click **Rooms** at the top right.  This will take you to the Conference Center Rooms.  From here you can
+
+* Create a Room
+* Edit a Room
+
+.. image:: ../_static/images/applications/fusionpbx_conference_center_rooms.jpg
+        :scale: 85%
+
+
+
+Conference Center Rooms Settings
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+.. image:: ../_static/images/applications/fusionpbx_conference_center_rooms_settings.jpg
+        :scale: 85%
+
+
+
diff --git a/source/applications/conference_controls.rst b/source/applications/conference_controls.rst
@@ -16,7 +16,7 @@ Call controls enable ability to assign digits to actions. They can be used to mu
 
 
 
-default Conference Control
+Default Conference Control
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. image:: ../_static/images/applications/fusionpbx_conference_controls1.jpg

diff --git a/source/dialplan/destinations.rst b/source/dialplan/destinations.rst
@@ -7,21 +7,15 @@ Destinations
 
 Inbound destinations are the DID/DDI, DNIS or Alias for inbound calls. `Click here for the youtube video`_
 
-
-
 Configure Inbound Destinations: (This will auto-configure an Inbound Route also)
 
-*Select* **Dialplan** from the drop-down list and then *click* **Destinations**. 
+.. Tip::
 
-.. image:: ../_static/images/fusionpbx_inboundd.jpg
-        :scale: 85%
+   Outbound destinations can be created also.
 
-Click on the
-
-.. image:: ../_static/images/plus.png
-        :scale: 85%
+*Select* **Dialplan** from the drop-down list and then *click* **Destinations**. 
 
-button on the right. 
+To add a destination **click** on the **plus** button on the right. 
 
 .. image:: ../_static/images/dialplan/fusionpbx_destinations.jpg
         :scale: 85%