Przeglądaj źródła

Update content, add new images and content, reorganize content. (#150)

* Update devices.rst

* Update devices.rst

* Update devices.rst

* image add

* Update extensions.rst

* Update external_sip_profile.rst

* Update external_ipv6_sip_profile.rst

* Update external_ipv6_sip_profile.rst

* image add

* Update users.rst

* Update home.rst

* Update applications.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Create sms_mms.rst

* Update home.rst

* Update home.rst

* Update applications.rst

* Update advanced.rst

* Update contributing.rst

* Update training.rst

* Update training.rst
Len 7 lat temu
rodzic
commit
d42e4967ed

BIN
source/_static/images/accounts/fusionpbx_accounts_extensions_advanced.jpg


BIN
source/_static/images/accounts/fusionpbx_users_4_5.jpg


+ 1 - 0
source/accounts/devices.rst

@@ -16,6 +16,7 @@ Used to define the information needed to assign SIP accounts and keys to provisi
 * Select from the drop down box the make/model.
 * Populate the lines section.
 * Populate the Key section.
+* (Optional) Populate the Settings section. These settings are the same as the variables from Advanced > Default Settings > Provisioning and can be overridden in this settings section. Just set the variable for the device you are adding.
 * Edit other fields as needed.
 * Click Save
 

+ 38 - 2
source/accounts/extensions.rst

@@ -9,6 +9,8 @@ Extensions
         :scale: 85%
 
 
+Basic Settings
+~~~~~~~~~~~~~~~~
 
 *  Extension 	
     Enter the alphanumeric extension. The default configuration allows 2 - 7 digit extensions.
@@ -65,8 +67,42 @@ Extensions
 *  Hold Music 	
     Select music or ring tones that will be used for music on hold for this extension.
 *  Context 	
-    The context is set by default to match the domain name or IP addres. It is usually correct by default and doesn't need to be changed in most cases.	
+    The context is set by default to match the domain name or IP addres. It is usually correct by default and doesn't need to be changed in most cases.
+
 *  Enabled
-    Whethe the extension is enabled or disabled.
+    Extension enabled or disabled.
 *  Description
     A description for the extension.
+
+
+Advanced Settings
+~~~~~~~~~~~~~~~~~~~
+
+Advanced settings in extensions. Be sure to know what and why you are changing these settings or you will risk causing issues for the extention.
+
+.. image:: ../_static/images/accounts/fusionpbx_accounts_extensions_advanced.jpg
+        :scale: 85%
+
+*  Auth ACL
+    Advanced auth acl uses.
+*  CIDR
+    Advanced cidr uses.
+*  SIP Force Contact
+    Choose whether to rewrite the contact port, or rewrite both the contact IP and port.
+*  SIP Force Expires
+    To prevent stale registrations SIP Force expires can override the client expire.
+*  MWI Account
+    MWI Account with user@domain of the voicemail to monitor.
+*  SIP Bypass Media
+    Choose whether to send the media stream point to point or in transparent proxy mode.
+*  Absolute Codec String
+    Absolute Codec String for the extension.
+*  Force ping
+    Use OPTIONS to detect if extension is reacheable.
+*  Domain
+    The domain the extension is currently saved on.
+*  Dial String
+    Location of the endpoint.
+    
+
+

+ 5 - 1
source/accounts/users.rst

@@ -2,7 +2,7 @@
 Users
 ************
 
-.. image:: ../_static/images/accounts/fusionpbx_users.jpg
+.. image:: ../_static/images/accounts/fusionpbx_users_4_5.jpg
         :scale: 85%
 
 
@@ -24,6 +24,10 @@ Define the users information to login to the web interface.
     The group the user is assigned.
 *  Domain
     The domain the user is assigned to.
+*  API Key
+    Generates an API Key
+*  Message Key
+    Generates a Key to use with Messages Application.
 *  Enable
     Whether the user is enabled.
 

+ 1 - 1
source/advanced.rst

@@ -3,7 +3,7 @@ Advanced
 ************
 
 
-In the Advanced menu you will find Adminer, Access Controls, App Manager, Backup, Command, Databases, Default Settings, Domains, Grammer Editor, Group Manager, Menu Manager, Modules, Number Translations, PHP Editor, Provision Editor, Sip Profiles, Script Editor, Settings, Transactions, Upgrade, Variables and XML Editor.
+In the **Advanced** menu you will find Adminer, Access Controls, App Manager, Backup, Command, Databases, Default Settings, Domains, Grammer Editor, Group Manager, Menu Manager, Modules, Number Translations, PHP Editor, Provision Editor, Sip Profiles, Script Editor, Settings, Transactions, Upgrade, Variables and XML Editor.
 
 
 

+ 100 - 0
source/advanced/external_ipv6_sip_profile.rst

@@ -8,3 +8,103 @@ External ipv6 Sip Profile
         :scale: 80%
 
 
+*  **Hostname-** Should be left blank and is for advanced use.
+
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| SIP Profile Setting Name  | SIP Profile Setting Value      | SIP Profile Setting Enabled | SIP Profile Setting Description |
++===========================+================================+=============================+=================================+
+| auth-calls                | FALSE                          | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| context                   | public                         | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| dbname                    | share_presence                 | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| debug                     | 0                              | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| dialplan                  | XML                            | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| disable-srv503            | TRUE                           | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| dtmf-duration             | 2000                           | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| dtmf-type                 | rfc2833                        | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| enable-100rel             | TRUE                           | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| enable-rfc-5626           | TRUE                           | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| ext-rtp-ip                | $${external_rtp_ip}            | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| ext-sip-ip                | $${external_sip_ip}            | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| force-register-db-domain  | $${domain}                     | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| force-register-domain     | $${domain}                     | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| hold-music                | $${hold_music}                 | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| inbound-codec-negotiation | generous                       | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| inbound-codec-prefs       | $${global_codec_prefs}         | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| local-network-acl         | localnet.auto                  | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| manage-presence           | FALSE                          | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| nonce-ttl                 | 60                             | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| odbc-dsn                  | $${dsn}                        | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| outbound-codec-prefs      | $${outbound_codec_prefs}       | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| presence-hosts            | $${domain}                     | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| rfc2833-pt                | 101                            | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| rtp-hold-timeout-sec      | 1800                           | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| rtp-ip                    | $${local_ip_v6}                | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| rtp-timeout-sec           | 300                            | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| rtp-timer-name            | soft                           | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| shutdown-on-fail          | TRUE                           | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| sip-capture               | no                             | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| sip-ip                    | $${local_ip_v6}                | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| sip-port                  | $${external_sip_port}          | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| sip-trace                 | no                             | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls                       | $${external_ssl_enable}        | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls-bind-params           | transport=tls                  | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls-cert-dir              | $${external_ssl_dir}           | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls-only                  | FALSE                          | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls-passphrase            |                                | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls-sip-port              | $${external_tls_port}          | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls-verify-date           | TRUE                           | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls-verify-depth          | 2                              | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls-verify-in-subjects    |                                | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls-verify-policy         | all|subjects_all               | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls-version               | $${sip_tls_version}            | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| track-calls               | FALSE                          | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| user-agent-string         | FreeSWITCH                     | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| zrtp-passthru             | TRUE                           | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+

+ 99 - 0
source/advanced/external_sip_profile.rst

@@ -8,3 +8,102 @@ External Sip Profile
         :scale: 80%
 
 
+
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| SIP Profile Setting Name  | SIP Profile Setting Value      | SIP Profile Setting Enabled | SIP Profile Setting Description |
++===========================+================================+=============================+=================================+
+| auth-calls                | FALSE                          | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| context                   | public                         | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| dbname                    | share_presence                 | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| debug                     | 0                              | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| dialplan                  | XML                            | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| disable-srv503            | TRUE                           | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| dtmf-duration             | 2000                           | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| dtmf-type                 | rfc2833                        | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| enable-100rel             | TRUE                           | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| enable-rfc-5626           | TRUE                           | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| ext-rtp-ip                | $${external_rtp_ip}            | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| ext-sip-ip                | $${external_sip_ip}            | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| force-register-db-domain  | $${domain}                     | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| force-register-domain     | $${domain}                     | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| hold-music                | $${hold_music}                 | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| inbound-codec-negotiation | generous                       | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| inbound-codec-prefs       | $${global_codec_prefs}         | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| local-network-acl         | localnet.auto                  | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| manage-presence           | FALSE                          | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| nonce-ttl                 | 60                             | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| odbc-dsn                  | $${dsn}                        | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| outbound-codec-prefs      | $${outbound_codec_prefs}       | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| presence-hosts            | $${domain}                     | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| rfc2833-pt                | 101                            | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| rtp-hold-timeout-sec      | 1800                           | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| rtp-ip                    | $${local_ip_v4}                | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| rtp-timeout-sec           | 300                            | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| rtp-timer-name            | soft                           | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| shutdown-on-fail          | TRUE                           | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| sip-capture               | no                             | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| sip-ip                    | $${local_ip_v4}                | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| sip-port                  | $${external_sip_port}          | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| sip-trace                 | no                             | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls                       | $${external_ssl_enable}        | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls-bind-params           | transport=tls                  | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls-cert-dir              | $${external_ssl_dir}           | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls-only                  | FALSE                          | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls-passphrase            |                                | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls-sip-port              | $${external_tls_port}          | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls-verify-date           | TRUE                           | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls-verify-depth          | 2                              | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls-verify-in-subjects    |                                | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls-verify-policy         | all|subjects_all               | FALSE                       |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| tls-version               | $${sip_tls_version}            | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| track-calls               | FALSE                          | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| user-agent-string         | FreeSWITCH                     | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+| zrtp-passthru             | TRUE                           | TRUE                        |                                 |
++---------------------------+--------------------------------+-----------------------------+---------------------------------+
+

+ 1 - 1
source/applications.rst

@@ -2,7 +2,7 @@
 Applications
 *************
 
-In the **Applications** menu (Apps) section you will find Call Block, Call Broadcast, Call Center, Call Detail Records, Call Flows, Conference Center, Contacts, Fax Server, Follow Me, IVR Menu, Music on Hold, Operator Panel, Phrases, Queues, Recordings, Ring Groups, Time Conditions and Voicemail.
+In the **Applications** menu (Apps) section you will find Bridges, Call Block, Call Broadcast, Call Center, Call Detail Records, Call Flows, Conference Center, Conference Controls, Conference Profiles, Contacts, Fax Server, Follow Me, Grandstream Wave, IVR Menu, Music on Hold, Operator Panel, Phrases, Queues, Recordings, Ring Groups, Streams, Time Conditions and Voicemail.  Other apps can be added also.
 
 
 

+ 8 - 0
source/applications/sms_mms.rst

@@ -0,0 +1,8 @@
+###########
+Messages
+###########
+
+Send/Receive text and picture messages(MMS).
+
+
+

+ 1 - 1
source/contributing.rst

@@ -44,5 +44,5 @@ How to Get Started:
   contributing/qa_testing.rst
   contributing/github_rebase.rst
   contributing/coding_standards
-#  contributing/directory_structure
+ #contributing/directory_structure
 

+ 8 - 2
source/getting_started/training.rst

@@ -2,17 +2,23 @@
 Training
 ###########
 
-FusionPBX offers different levels of training. We love helping people and companies succeed.  From the small family business, someone that loves to tinker with technology, to major companies all around the world.
+FusionPBX offers different levels of training. We love helping people and companies succeed.  
+
+* Small family business.
+* Someone that loves to tinker with technology.
+* Major companies all around the world.
 
 Free
 ------
 
+FusionPBX has content available in this document and video's on youtube to help get you started.
+
 * Free Self help is available for you right here at docs.fusionpbx.com
 * Video's at https://youtube.com/fusionpbx
 
 
 `Paid Training and technical support <https://www.fusionpbx.com/training.php>`_
--------------------------------------
+------------------------------------------------------------------------------------
 
 FusionPBX offers an Admin class, Advanced class and an affordable Continuing Education class.  If you want to accelerate your understanding of how to use FusionPBX and unleash your full potential these classes are for you.
 

+ 1 - 1
source/home.rst

@@ -1,7 +1,7 @@
 Home
 ======
 
-
+The **Home** menu gives access to Account Settings, Dashboard and the option to Logout.
 
 
 .. toctree::

+ 8 - 3
source/index.rst

@@ -45,6 +45,8 @@ Benefits of FusionPBX
 +-------------------------+-----------------------+---------------------------------+------------------------------------------+
 | `Multi-Tenant`_         | `Music on Hold`_      |    `Queues`_                    |      `Recordings`_                       |
 +-------------------------+-----------------------+---------------------------------+------------------------------------------+
+| `Device Provisioning`_  | `Streams`_            |   `QR Code Provisioning`_       | `SMS/MMS ready`_                         |                                                                        
++-------------------------+-----------------------+---------------------------------+------------------------------------------+
 | `Time Conditions`_      | `WebRTC ready`_       |    `Voicemail`_                 |      `and lots more...`_                 |
 +-------------------------+-----------------------+---------------------------------+------------------------------------------+
 
@@ -55,9 +57,12 @@ We are a **global community** that has an open and **very friendly** ecosystem.
 
 Most of the core folks who develop and use FusionPBX can be found hanging out in Freenode IRC in the **#fusionpbx** channel. Come join us and meet the team.
 
-
-.. _FreeSWITCH: http://www.freeswitch.org
-.. _FusionPBX: http://www.fusionpbx.com
+.. _Device Provisioning: applications/provision.html
+.. _Streams: applications/streams.html
+.. _QR Code Provisioning: applications/gs_wave.html
+.. _SMS/MMS ready: applications/sms_mms.html
+.. _FreeSWITCH: https://www.freeswitch.org
+.. _FusionPBX: https://www.fusionpbx.com
 .. _Click here for the FusionPBX youtube channel: https://www.youtube.com/playlist?list=PLrhVQpI_CtOwQNB_lsNIxrl9SOAuo9ZSF
 .. _IVR Menus: applications/ivr.html
 .. _Call Broadcast: applications/call_broadcast.html