Merge pull request #36 from Len-PGH/master

add content/edits

source/additional_information.rst

@@ -8,6 +8,7 @@ Additional Information
 
 
 
+
 .. toctree::
   :maxdepth: 3
   :glob:
@@ -15,3 +16,5 @@ Additional Information
   additional_information/fail2ban.rst
   additional_information/freeswitch.rst
   additional_information/testimonials.rst
+  additional_information/password_reset.rst
+  additional_information/feature_codes.rst

source/additional_information/feature_codes.rst

@@ -0,0 +1,153 @@
+##################
+Feature Codes
+##################
+
+
+| Below are the "*" codes used with FusionPBX.  You can also create more as needed.  If you do be sure to pick ones that are not currently in use.
+
+|
+
+**Basic**
+^^^^^^^^^
+
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+| Feature Code           | Name                    | Detail                                                                        |
++========================+=========================+===============================================================================+
+| *1                     | Call Transfer           |Transfer a call to another extension                                           |
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+| *2                     | Record Active Call      |                                                                               |
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+| *4                     | Attended Call Transfer  | Attended call transfer to another extension. After extension number press #   |
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+| *411                   | Directory               | *DIR to dial by name.                                                         |
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+| *3472                  | DISA                    | *DISA followed by Administrative PIN to receive a dialtone and call out.      |
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+| *5900                  | Valet Park              | Attended Transfer (park). The park extension will be played back to you.      |
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+| *5901-5999             | Valet Un-Park           | Retrieve a Valet Parked call.                                                 |
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+| *67 <phone number>     | Call Privacy            | Activate call privacy                                                         |
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+| *69                    | Call Return             | Call back the last incoming number                                            |
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+| *732                   | Record                  |*REC followed by Administrative PIN to record a message.                       |
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+| *8[ext]                | Extension Intercom      | Page a specific extension.                                                    |
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+| *870                   | Redial                  | Redial a number                                                               |
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+| *xx                    | Talking Date            | To Do                                                                         |
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+| *xx                    | Talking Time            | To Do                                                                         |
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+| *xx                    | Talking Date & Time     | To Do                                                                         |
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+| *925                   | Wakeup Call             | Schedule a wakeup call                                                        |
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+
+
+**Voicemail**
+^^^^^^^^^^^^^
+
+
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+| Feature Code           | Name                    | Detail                                                                        |
++========================+=========================+===============================================================================+
+| *97                    | Voicemail               | The system detects the extension, and will prompt for your password           |
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+| *98                    | Check any Voicemail box | The system will prompt for both your id (extension number) and password       |
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+| *4000                  | Check any Voicemail box | The system will prompt for both your id (extension number) and password       |
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+| *99 <extension>        | Send to Voicemail       | Send a call directly to voicemail                                             |
++------------------------+-------------------------+-------------------------------------------------------------------------------+
+
+**Conference**
+^^^^^^^^^^^^^^
+
+
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| Feature Code          | Name                    | Detail                                                                        |
++=======================+=========================+===============================================================================+
+| *3001-3099            | Conference (8khz)       | Conference room with 8khz (cellphone quality) audio                           |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| *3101-3199            | Conference (16khz)      | Conference room with 16khz audio                                              |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| *3201-3299            | Conference (32khz)      | Conference room with 32khz audio                                              |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| *3301-3399            | Conference (48khz)      | Conference room with 48khz (cd quality) audio                                 |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+|                       |                         |           Additional Conference numbers can be added via the GUI              |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+
+**Group**
+^^^^^^^^^^
+
+
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| Feature Code          | Name                    | Detail                                                                        |
++=======================+=========================+===============================================================================+
+| *8                    | Group Intercept         |                                                                               |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+ 
+| *80 <Group ID>        | Delete from Group       | Remove extension from a group using 2 digit group ID. See Call Groups.        |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| **81 <Group ID>       | Add to Group            | Add extension to a group using 2 digit group ID. See Call Groups.             |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| **82 <Group ID>       | Simultaneous Ring       | Ring an entire group simultaneously (using a 2 digit group ID)                |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| **83 <Group ID>       | Sequential Ring         | Ring an entire group sequentially (using a 2 digit group ID)                  |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| **2001                | Ring Billing            | Ring the Billing Group                                                        |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| **2002                | Ring Support            | Ring the Support Group                                                        |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+
+
+**Advanced**
+^^^^^^^^^^^^^
+
+
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| Feature Code          | Name                    | Detail                                                                        |
++=======================+=========================+===============================================================================+
+| *8[ext]               | Extension Intercom      | Page a specific extension.                                                    |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| *33 <ext>             | Eavesdrop               | Listen to the call. Press 1 for remote, 2 for local, 3 for full conversation. |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| *886                  | Global Intercept        | Intercept a call that is ringing.                                             |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| **8 <ext>             | Intercept an extension  | Intercept a specific extension.                                               |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+
+
+**Miscellaneous**
+^^^^^^^^^^^^^^^^^
+
+
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| Feature Code          | Name                    | Detail                                                                        |
++=======================+=========================+===============================================================================+
+| *9192                 | Info                    | Sends information to the console.                                             |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| *9193                 | Video Record            | Record Video.                                                                 |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| *9194                 | Video Playback          | Playback Video.                                                               |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| *9195                 | Delay Echo              | Audio is played back after a slight delay.                                    |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| *9196                 | Echo Test               | Echo Test.                                                                    |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| *9197                 | Milliwatt Tone          | Tone Playback                                                                 |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| *9664                 | Test MoH                | Test Music on Hold                                                            |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+| *5000                 | Default Attendant       | Call the default auto-attendant                                               |
++-----------------------+-------------------------+-------------------------------------------------------------------------------+
+
+**Adding extra feature codes**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+https://wiki.freeswitch.org/wiki/Misc._Dialplan_Tools_say#Talking_Clock
+
+

source/additional_information/password_reset.rst

@@ -0,0 +1,59 @@
+##############
+Password Reset
+##############
+
+
+| Here some rough steps to change the password of the database. The password can only be changed and not recovered.
+
+|
+
+| The database contains a table called v_users which contains the username, password and salt. The password is the md5 hash of the password and the salt. 
+
+**Password Hash**
+^^^^^^^^^^^^^^^^^
+
+| Use the following commands to generate the password hash. Don't forget to provide your own salt and password.
+
+::
+
+ echo '<?php $salt = "random-salt-goes-here";$password = "put your password here"; echo md5($salt.$password)."\n"; ?>' > /tmp   /test.php
+
+
+| Run the php file from command line.
+
+::
+
+ php /tmp/test.php
+
+
+**SQLite**
+^^^^^^^^^^^
+
+| Install sqlite3 which can be be used to modify the database fusionpbx.db. Then open the database with the following:
+ 
+::
+
+ sqlite3 fusionpbx.db
+
+**PostgreSQL**
+^^^^^^^^^^^^^^^
+
+| Connect to the PostgreSQL database. Once you are running psql you can use \l to list the databases and \c to connect to one of them. After running the SQL Query then use \q to quit.
+
+::
+
+ su postgres
+ psql
+ \c fusionpbx
+
+
+**Change the Password**
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+The hashed password and the salt can be updated using the command:
+
+::
+
+ update v_users set password = 'replace-with-password-hash-from-php-script', salt = 'replace-with-your-random-salt' where       username = 'superadmin';
+ 
+ 

source/manual/menu_add_ons.rst

@@ -2,29 +2,34 @@
 Menu Add-ons
 *************
 
-  Menu add-ons are apps thats are either not in the menu by default or archived and could be deprecated.  https://github.com/fusionpbx/fusionpbx-apps
+|  Menu add-ons are apps thats are either not in the menu by default or archived and could be deprecated.  https://github.com/fusionpbx/fusionpbx-apps
   
 |
 
-Acl
+*Acl*
 ----
 
-Move the acl to the optional Apps directory as it isn't completed yet
+| **deprecated** (Now part of Advanced -> Access Controls)
 
 cdr
 ----
 
-Content placeholder
+| Optional version of Apps -> Call Detail Records.
+
 
 content
 -------
 
+| Manage Content for any page in the interface.
+
 fifo_agents
 -----------
 
 get_call_details
 ----------------
 
+| Get call details for active calls results are in json.
+
 hot_desking
 -----------
 
@@ -33,51 +38,79 @@ Code integrated starting version 4.0.0 (Goto Accounts > Devices for current hot_
 hunt_groups
 -----------
 
+|  **deprecated** (Now part of Appsv-> Ring Groups) A Hunt Group is a list of destinations that can be called in sequence or simultaneously.
+
 invoices
 --------
 
+| A handy way to make an invoice or quote PDF for clients.
+
 languages
 ---------
 
+| initial version of languages.
+
 php_service
 -----------
 
+| Manages multiple dynamic and customizable services. There are many possible uses including alerts, ssh access control, scheduling commands to run, and many others uses that are yet to be discovered.
+
 profiles
 --------
 
+| Use this to configure your SIP profiles.
+
 roku
 -----
 
 schemas
 -------
 
+| Provides the ability to quickly define information to store and dynamically makes tools available to view, add, edit, delete, and search.
+
 servers
 -------
 
 signup
 -------
 
+| Allows customers on the internet to signup for a user account.
+
 sipml5
 -------
 
+| Add sipml5 an optional webrtc client.
+
 soft_phone
 -----------
 
+| Freeswitch Softphone used with  mod_portaudio.
+| See http://wiki.freeswitch.org/wiki/Mod_portaudio and http://wiki.freeswitch.org/wiki/Freeswitch_softphone
+
 tickets
 --------
 
+| Simple Ticket Tracking System To allow customer Support
+
 users_bulk_add
 ---------------
 
 voicemail_msgs
 --------------
 
+| Voicemails can be listed, played, downloaded and deleted. (Now part of Apps -> Voicemail
+
 voicemail_status
 ----------------
 
+| Shows which extensions have voicemails and how many.
+
 xmpp
 ----
 
+| XMPP Manager is an optional menu item. In order to have the option for XMPP Manager there are a few step to take to enble XMPP. Utilizes the Jingle protocol. Jingle is an extension to the Jabber/XMPP protocol.
+| http://docs.fusionpbx.com/en/latest/applications_optional/xmpp.html
+
 Zoiper
 -------
 
@@ -89,7 +122,7 @@ Zoiper
 
 
 Zoiper.com account setup
-========================
+^^^^^^^^^^^^^^^^^^^^^^^^
 
 | There are two parts to make this function. http://oem.zoiper.com and Fusionpbx menu add-on.
 
@@ -108,7 +141,7 @@ Zoiper.com account setup
 |
 
 Zoiper menu add-on for Fusionpbx
-================================
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 | On your server