ソースを参照

Updated Access controls & Voicemail transcription docs (#301)

* Update voicemail_transcription.md

* Update access_controls.md

* Update access_controls.md

* Update access_controls.md

* Created file for Access Controls screenshots

* Add files via upload

* Update access_controls.md

* Update access_controls.md

* Delete source/_static/images/advanced/access_controls/place_holder
Anthony 2 ヶ月 前
コミット
bbe33eb79b

BIN
source/_static/images/advanced/access_controls/fusionpbx_access_controls1.png


BIN
source/_static/images/advanced/access_controls/fusionpbx_access_controls2.png


BIN
source/_static/images/advanced/access_controls/fusionpbx_access_controls3.png


BIN
source/_static/images/advanced/access_controls/fusionpbx_access_controls4.png


+ 51 - 25
source/advanced/access_controls.md

@@ -5,37 +5,63 @@ several purposes for using the ACL.
 
 **providers - access conroll list**
 
--   The main purpose of the Providers list is for your voip provider
-    (carrier) IP addresses to the CIDR.
--   Be careful with what and how you use ACL.
--   Most common mistakes result in calls not working between extensions
-    and other undesirable results.
--   Be sure to keep **providers** access control (formerly called
-    domains) to default deny.
--   Do not put your public ip or phone IP addresses in the domains
-    access control list.
--   Don\'t supply both the domain and the cidr on the same node.
--   If adding a single IP address to the CIDR field make sure to add /32
-    on the end of the IP address.
-
-## Access Control Example
-
-Goto Advanced \> Access Controls. Click the edit icon for **providers**
-was renamed from **domains**. At the bottom under **nodes** click the
-plus icon. In the example below make sure to change the 12.34.56.0 to
-your VoIP providers IP address if adding to the Providers access control
-list.
+The main purpose of the Providers list is for your voip provider (carrier) IP addresses 
+to the CIDR.
 
+Be careful with what and how you use ACL. Most common mistakes result in    
+calls not working between extensions and other undesirable results.   
+
+:::{improtant}   
+Make sure you keep the **providers** access control (formerly known as   
+"domains") as default "**deny**".   
+
+Do not put your public ip or phone IP addresses in the domains access control list.   
+
+Avoid putting both the domain and cidr on the same node.   
+:::   
+
+If adding a single IP address to the CIDR field make sure to add /32   
+at the end of the IP address.   
+
+## Access Controls Example
+
+- Navigate to **Advanced** > **Access Controls**.
+
+![image](../_static/images/advanced/access_controls/fusionpbx_access_controls1.png)
+
+- Click the **providers** tab to edit it.
+
+![image](../_static/images/advanced/access_controls/fusionpbx_access_controls2.png)
+
+- Under **nodes** select the **Type** to **allow** or **deny**.
+
+![image](../_static/images/advanced/access_controls/fusionpbx_access_controls3.png)
+
+- Add the desired IP address under **CIDR** and add a description (optional).
+- Then click save. 
+
+![image](../_static/images/advanced/access_controls/fusionpbx_access_controls4.png)
+
+:::{note}   
+In the example below, make sure to change the 12.34.56.0 to   
+your VoIP providers IP address if adding to the providers access control list.   
+:::   
+
+```
     Type choose allow
     CIDR enter the 12.34.56.0/32
     Domain (Leave Blank, used for advanced scenarios)
     Description (Carrier Name)
+```
 
-Click save
-
-Goto \> Status \> Sip Status and click **reloadacl**.
+- Click save.
+- Then navigate to **Status** > **Sip Status** and click **reloadacl**.
 
-Under Status \> log viewer you should notice the ip added. This can be
-seen also from command line fscli by using **reloadacl**
+:::{note}   
+Under **Status** > **Log viewer** you should notice the ip added. This can be   
+seen also from command line fscli by using **reloadacl**.   
+:::
 
+```
     [NOTICE] switch_utils.c:545 Adding 12.34.56.0/32 (allow) [] to list domains
+```

+ 8 - 8
source/applications/voicemail_transcription.md

@@ -33,8 +33,8 @@ This document provides a step-by-step guide for setting up the email transcripti
 | Subcategory | Type   | Value            | Enabled | Description                                           |
 |-------------|--------|------------------|---------|-------------------------------------------------------|
 | api_key     | text   | secret_key       | true    | Speech to Text API key                                |
-| api_url     | text   | https://api...   | false   | ***Leave this alone unless using a custom service*** |
-| enabled     | boolean| true            | true    | Speech to Text Enabled                                |
+| api_url     | text   | https://api...   | false   | ***Leave this alone unless using a custom service***  |
+| enabled     | boolean| true             | true    | Speech to Text Enabled                                |
 | engine      | text   | openai           | true    | Options: openai, google, azure, custom                |
 
 - Click **Reload** to apply the changes.
@@ -58,11 +58,11 @@ The primary function handling voicemail transcriptions is defined in [transcribe
 
 ---
 
-# Voicemail Transcription in FusionPBX 5.2 and Older
+## Version 5.2 or Older
 
 Uses API services to transcribe voicemails into text for use in the app-sms and voicemail-to-email options. Bing's Speech API or other generic APIs can be used.
 
-## IBM Watson API
+### IBM Watson API
 Sign up and language information is located on [IBM Watson's Site](https://cloud.ibm.com/catalog/services/speech-to-text).
 
 :::{warning}   
@@ -96,7 +96,7 @@ Click "Flush Cache", "Reload XML", and "Rescan".
 
 If you entered your keys correctly, you should now start getting transcriptions delivered in your voicemail-to-email and see them on the Messages page.
 
-## Azure API
+### Azure API
 **Go to Advanced > Default Settings.**  
 Add the following entries:
 
@@ -116,7 +116,7 @@ Click "Flush Cache", "Reload XML", and "Rescan".
 
 If you entered your keys correctly, you should now start getting transcriptions delivered in your voicemail-to-email and see them on the Messages page.
 
-## Google API
+### Google API
 **Go to Advanced > Default Settings.**  
 Add the following entries:
 
@@ -136,7 +136,7 @@ Click "Flush Cache", "Reload XML", and "Rescan".
 
 If you entered your keys correctly, you should now start getting transcriptions delivered in your voicemail-to-email and see them on the Messages page.
 
-## Bing API
+### Bing API
 Recommend using Azure as an alternative to Bing.
 
 Sign up and language information is located on [Microsoft Site](https://www.microsoft.com/cognitive-services/en-us/Speech-api/documentation/API-Reference-REST/BingVoiceRecognition).  
@@ -164,7 +164,7 @@ Click "Flush Cache", "Reload XML", and "Rescan".
 
 If you entered your keys correctly, you should now start getting transcriptions delivered in your voicemail-to-email and see them on the Messages page.
 
-## Custom API
+### Custom API
 Currently does not work with the FusionPBX email_queue.
 
 API info from the Speech-to-Text provider of your choice is needed, or you can self-host a transcription engine like [Mozilla DeepSpeech](https://git.callpipe.com/fusionpbx/deepspeech_frontend) or [Kaldi ASR](https://github.com/dialogflow/asr-server).