Merge pull request #35 from Len-PGH/master

add content

source/additional_information.rst

@@ -0,0 +1,17 @@
+######################
+Additional Information
+######################
+
+
+
+
+
+
+
+.. toctree::
+  :maxdepth: 3
+  :glob:
+
+  additional_information/fail2ban.rst
+  additional_information/freeswitch.rst
+  additional_information/testimonials.rst

source/advanced/fail2ban.rst → source/additional_information/fail2ban.rst

@@ -2,7 +2,7 @@
 Fail2Ban
 ##########
 
-| For information about Fail2Ban on FreeSWITCH, http://wiki.freeswitch.org/wiki/Fail2ban see their wiki
+| For information about Fail2Ban on FreeSWITCH, http://wiki.freeswitch.org/wiki/Fail2ban see their wiki.
 
 | **Logs**
 | This will log FusionPBX authentication failures to syslog (AUTH_LOG). This file can be in different places depending on how rsyslog, or syslog is configured.

source/additional_information/testimonials.rst

@@ -0,0 +1,4 @@
+############
+Testimonials
+############
+

source/applications_optional/xmpp.rst

@@ -104,11 +104,8 @@ Bridge statement should look like: dingaling/gtalk/[email protected] replace
 
 |
 
-
-
-############
 Enable XMPP
-############
+===========
 
 
 |

source/getting_started.rst

@@ -18,5 +18,6 @@ Follow the menu to the left and you will have a working PBX in no time. For PDF
   :glob:
 
   getting_started/installation_recommended.rst
+  getting_started/register_phones.rst
   getting_started/post_installation.rst
   iptables.rst

source/getting_started/register_phones.rst

@@ -0,0 +1,151 @@
+
+Registering Phones
+-------------------
+
+|
+
+Welcome to the Registering Phones section.  Here you will find how to configure some of the most popular phones to use with FusionPBX. 
+
+|
+
+Use this to configure your SIP extensions.
+
+|
+
+Grandstream
+^^^^^^^^^^^^
+
+.. image:: ../_static/images/fusionpbx_grandstream4.jpg
+        :scale: 85%
+
+|
+
+Registering an **Extension** using a hardware phone or adapter (ata) using Grandstream. 
+
+|
+
+Granstream is one of the common brand of phone and adapters for voip.  From call centers to offices and home offices Grandstream products can be found.  Grandstream has a large selection of hardware from phones, video phones to analog telephone adapters.
+
+|
+
+In our example we will register an analog telephone adapter (ata) model HT701.
+
+|
+
+1. Goto the device ip address. The default password should be admin. Enter admin and click login
+
+.. image:: ../_static/images/fusionpbx_grandstream.jpg
+        :scale: 85%
+
+|
+
+2. Click on the **FXS PORT** tab on the top right.
+
+| ``Primary Sip Server: subdomain.domain.com``
+| ``Failover SIP Server: subdomain1.domain.com (this can be left blank or can use Primary if only 1 sip server)``
+| ``SIP User ID: 1000``
+| ``Authenticated Password: thepassword``
+
+|
+
+Click **Update** then click **Apply** at the bottom
+
+|
+
+.. image:: ../_static/images/fusionpbx_grandstream2.jpg
+        :scale: 85%
+
+|
+
+3. Click the **Status** tab on the top left.  You should see the *Registration* as **Registered** and the *User ID* **1000**
+
+.. image:: ../_static/images/fusionpbx_grandstream1.jpg
+        :scale: 85%
+
+|
+
+- Troubleshooting tips
+
+|
+
+* Check, double check that the correct extension number and password is being used.
+* Reboot the device.
+* Check Fail2ban and see if the ip got blocked.
+* Make sure you have created an DNS A record for the domain being used and there are no typos
+* Nat, firewalls and router settings.  Some brands of routers can cause issues.  Google the make and model of router or firewall appliance for common settings or remedies.
+* Visit Grandstream Supoprt http://www.grandstream.com/support
+|
+
+Zoiper
+^^^^^^^
+
+|
+
+Registering an **Extension** using the softphone Zoiper.
+
+|
+
+In the ever changing world of voip businesses are moving away from hardware phones.  From call centers to home offices Zoiper and many other softphones make use of software for communication needs for not only voice but video and faxing. This example will show how to register an extension using Zoiper for Windows. *Note* Zoiper can be used on several operating systems and mobile devices.
+
+|
+1. Download the software. .. Zoiper: http://www.zoiper.com/
+2. Install the software.
+3. If the software isn't open click the Zoiper icon to open from the desktop or start menu.
+
+.. image:: ../_static/images/fusionpbx_zoiper.jpg
+        :scale: 85%
+
+|
+
+4. Click on **Settings**
+
+.. image:: ../_static/images/fusionpbx_zoiper1.jpg
+        :scale: 85%
+
+|
+
+5. Click on **Preferences**
+
+.. image:: ../_static/images/fusionpbx_zoiper2.jpg
+        :scale: 85%
+
+|
+
+6. Click on **Create account**
+
+.. image:: ../_static/images/fusionpbx_zoiper3.jpg
+        :scale: 85%
+
+|
+
+7. Enter the user, password and domain name.
+
+| ``user: 1000``
+| ``password: thepassword``
+| ``domain: sub.domain.com``
+
+|
+
+.. image:: ../_static/images/fusionpbx_zoiper4.jpg
+        :scale: 85%
+
+|
+
+8. Click ok.  You should have **Registered** at the top right
+
+.. image:: ../_static/images/fusionpbx_zoiper5.jpg
+        :scale: 85%
+
+|
+
+- Troubleshooting tips
+
+|
+
+* Check, double check that the correct extension number and password is being used.
+* Check Fail2ban and see if the ip got blocked.
+* Make sure you have created an DNS A record for the domain being used and there are no typos
+* Nat, firewalls and router settings.  Some brands of routers can cause issues.  Google the make and model of router or firewall appliance for common settings or remedies.
+* Visit Zoiper Community Supoprt http://community.zoiper.com/
+
+|

source/index.rst

@@ -72,9 +72,7 @@ Getting Started
     applications.rst
     advanced.rst
     manual.rst
-    advanced/fail2ban.rst
-    advanced/freeswitch.rst
-    testimonials.rst
+    additional_information.rst
     contributing.rst
     doc_guide.rst
 

source/manual.rst

@@ -2,10 +2,10 @@
 User Manual
 ***********
 
-Here you will find information on every menu item in FusionPBX 
+Here you will find information on every menu item in FusionPBX plus add-on apps that are not covered in the other section of the documentation.
 
 .. image:: _static/images/fusionpbx_menu_full.jpg
-        :scale: 85%
+        :scale: 100%
 
 
 .. toctree::
@@ -18,4 +18,4 @@ Here you will find information on every menu item in FusionPBX
   manual/apps
   manual/status
   manual/advanced
-  manual/multi_tenant
+  manual/menu_add_ons

source/manual/menu_add_ons.rst

@@ -0,0 +1,168 @@
+*************
+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
+  
+|
+
+Acl
+----
+
+Move the acl to the optional Apps directory as it isn't completed yet
+
+cdr
+----
+
+Content placeholder
+
+content
+-------
+
+fifo_agents
+-----------
+
+get_call_details
+----------------
+
+hot_desking
+-----------
+
+Code integrated starting version 4.0.0 (Goto Accounts > Devices for current hot_desking) 
+
+hunt_groups
+-----------
+
+invoices
+--------
+
+languages
+---------
+
+php_service
+-----------
+
+profiles
+--------
+
+roku
+-----
+
+schemas
+-------
+
+servers
+-------
+
+signup
+-------
+
+sipml5
+-------
+
+soft_phone
+-----------
+
+tickets
+--------
+
+users_bulk_add
+---------------
+
+voicemail_msgs
+--------------
+
+voicemail_status
+----------------
+
+xmpp
+----
+
+Zoiper
+-------
+
+| QR and app provisioning with Zoiper
+
+| This menu add-on will enable the abliity to do QR provisioning from IOS or android Zoiper app.  Zoiper has designed the process in a way that is cross platform.  Fusionpbx has the ability to click the extension you want to provision and a link wil open to either download the app on multiple platforms or if you have the app installed on a mobile device you can use the QR code scanner to scan a QR image and the mobile is ready to use.
+
+| We will walk through the process
+
+
+Zoiper.com account setup
+========================
+
+| There are two parts to make this function. http://oem.zoiper.com and Fusionpbx menu add-on.
+
+| This all adds a one-click install for both the Desktop and Mobile Zoiper APPs in the User Portal. The page is accessible by end users.
+
+| This can be done with the FREE Zoiper OEM account or can use the paid versions for more customization like branding.
+
+| 1. Go to: https://oem.zoiper.com/
+| 2. Sign up for Login
+| 3. Configure your Desktop and Mobile Apps with the information you want.
+| 4. Then click "CONFIGURE" Under Desktop. 
+| 5. This will give you a LINK with a PAGE ID:(32 character)
+| 6. https://www.zoiper.com/en/page/MYPAGEID?u=&h=&p=&o=&t=&x=&a=&tr="
+| 7. Copy the page ID
+
+|
+
+Zoiper menu add-on for Fusionpbx
+================================
+
+| On your server
+
+::
+
+ git clone https://github.com/fusionpbx/fusionpbx-apps
+ cp -R fusionpbx-apps/zoiper /var/www/fusionpbx/app
+ chown -R www-data:www-data /var/www/fusionpbx/app/zoiper
+
+| 1. Log into the FusionPBX webpage
+| 2. Advanced -> Upgrade
+| 3. Menu Defaults and Permission Defaults.
+| 4. Log out and back in
+
+| Advanced -> Default Settings
+
+| **Note** **MYPAGEID** and **provider_id** are two different sets of characters.  You can also find these by going into the oem.zoiper.com login and click "view" on the moblie section.
+
+
+.. image:: ../_static/images/fusionpbx_zoiper9.jpg
+        :scale: 75%
+
+| **provider_id**
+
+::
+
+ provider_id
+ The Do It Yourself way: make your own page with instructions
+ 
+ If you want to customize this page, you can do so, just make sure to embed this html code on your website:
+ <img src="https://oem.zoiper.com/qr.php?provider_id=>>>>>>>09876543210987654321098765432199<<<<<<<&u=&h=&p=&o=&t=&x=&a=&tr=" alt="QR image"  />
+
+| **MYPAGEID**
+
+::
+
+ MYPAGEID
+ The easy way: send your customers to our landing page
+ Add a link on your website to this step by step tutorial on our website : (**click here** to see it in action).
+ <a href="https://www.zoiper.com/en/page/>>>>>>>>c1234567890123456789012345678901<<<<<<<?u=&h=&p=&o=&t=&x=&a=&tr=">Configuration instructions for Android and iOS</a>
+
+::
+
+ Add a Default Setting
+ Category: zoiper
+ Subcategory: provider_id(32 character)
+ Type: text
+ Value: MYPAGEID(32 character)
+ Enabled: True
+ Save
+
+| Goto Apps -> Zoiper
+| Superadmin will see a list of ALL USER EXTENSIONS
+| Users will only see the extensions assigned to them.
+
+| Click on a link and it will take you to the Zoiper Site. Follow instructions there to download and install.
+

source/manual/multi_tenant.rst

@@ -1,84 +0,0 @@
-*************
-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
-  
-|
-
-Acl
-----
-
-Move the acl to the optional Apps directory as it isn't completed yet
-
-cdr
-----
-
-Content placeholder
-
-content
--------
-
-fifo_agents
------------
-
-get_call_details
-----------------
-
-hot_desking
------------
-
-Code integrated starting version 4.0.0 (Goto Accounts > Devices for current hot_desking) 
-
-hunt_groups
------------
-
-invoices
---------
-
-languages
----------
-
-php_service
------------
-
-profiles
---------
-
-roku
------
-
-schemas
--------
-
-servers
--------
-
-signup
--------
-
-sipml5
--------
-
-soft_phone
------------
-
-tickets
---------
-
-users_bulk_add
----------------
-
-voicemail_msgs
---------------
-
-voicemail_status
-----------------
-
-xmpp
-----
-
-zoiper
--------
-
-QR provisioning with Zoiper

source/testimonials.rst

@@ -1,4 +0,0 @@
-#############
-Testimonials
-#############
-