2
0
Эх сурвалжийг харах

Merge branch 'master' of https://github.com/fusionpbx/fusionpbx-docs

Len 7 жил өмнө
parent
commit
455833050c

+ 0 - 1
source/additional_information.rst

@@ -13,7 +13,6 @@ Additional Information
   :maxdepth: 3
   :glob:
 
-  additional_information/fail2ban.rst
   additional_information/freeswitch.rst
   additional_information/testimonials.rst
   additional_information/password_reset.rst

+ 0 - 230
source/additional_information/fail2ban.rst

@@ -1,230 +0,0 @@
-##########
-Fail2Ban
-##########
-
-| 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.
-
-|**Ubuntu**
-| /var/log/auth.log
-
-| **Examples**
-| **GUI Login**
-
-| incorrect username
-
-::
-
- Feb  1 11:35:11 your_hostname FusionPBX: [w.x.y.z] authentication failed for login_username
- 
-
-| incorrect password
- 
-::
- 
- Feb  1 12:07:27 your_hostname FusionPBX: [w.x.y.z] authentication failed for superadmin
-
-
-| **Provisioning**
-| Created from the code in /fusionpbx/mod/provision/index.php Please doublecheck this!
-
-::
-
- Feb  1 12:07:27 your_hostname FusionPBX: [w.x.y.z] provision attempt bad password for AA:BB:CC:DD:EE:FF
-
-| **Setting up Fail2Ban**
-| **RegEx**
-| You can test the regex with fail2ban-regex
-
-::
-
- '[hostname] FusionPBX: \[<HOST>\] authentication failed'
-
-|
-
-| **Configuration**
-| **Jail Options**
-
-| Every jail can be customized by tuning the following options:
-
-+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| Name                  | Default               |                                Description                                                                                        |
-+=======================+=======================+===================================================================================================================================+
-| filter                | Campground            | Name of the filter to be used by the jail to detect matches. Each single match by a filter increments the counter within the jail |
-+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| logpath               | /var/log/messages     | Path to the log file which is provided to the filter                                                                              |
-+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| maxretry              | 3                     | Number of matches (i.e. value of the counter) which triggers ban action on the IP.                                                |
-+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| findtime              | 600 sec               | The counter is set to zero if no match is found within "findtime" seconds.                                                        |
-+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| bantime               | 600 sec               | Duration (in seconds) for IP to be banned for.                                                                                    |
-+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------+
-
-
-|
-
-| **Filter Rules**
-| vim /etc/fail2ban/filter.d/fusionpbx.conf
-
-::
-
- # Fail2Ban configuration file
- #
- # Author: soapee01
- #
- 
- [Definition]
- 
- # Option:  failregex
- # Notes.:  regex to match the password failures messages in the logfile. The
- #          host must be matched by a group named "host". The tag "<HOST>" can
- #          be used for standard IP/hostname matching and is only an alias for
- #          (?:::f{4,6}:)?(?P<host>[\w\-.^_]+)
- # Values:  TEXT
- #
- #failregex = [hostname] FusionPBX: \[<HOST>\] authentication failed
- #[hostname] variable doesn't seem to work in every case. Do this instead:
- failregex = .* FusionPBX: \[<HOST>\] authentication failed for
-           = .* FusionPBX: \[<HOST>\] provision attempt bad password for
- 
- # Option:  ignoreregex
- # Notes.:  regex to ignore. If this regex matches, the line is ignored.
- # Values:  TEXT
- #
- ignoreregex =
-
-
-| add the following to /etc/fail2ban/jail.local
-
-::
-
- [fusionpbx]
- 
- enabled  = true
- port     = 80,443
- protocol = tcp
- filter   = fusionpbx
- logpath  = /var/log/auth.log
- action   = iptables-allports[name=fusionpbx, protocol=all]
- #          sendmail-whois[name=FusionPBX, dest=root, [email protected]] #no smtp server installed
-
-
-| Add /etc/fail2ban/filter.d/freeswitch.conf with the contents:
-
-::
-
- # Fail2Ban configuration file
- #
- # Author: Rupa SChomaker (first two regex)
- 
- [Definition]
- 
- # Option:  failregex
- # Notes.:  regex to match the password failures messages in the logfile. The
- #          host must be matched by a group named "host". The tag "<HOST>" can
- #          be used for standard IP/hostname matching and is only an alias for
- #          (?:::f{4,6}:)?(?P<host>[\w\-.^_]+)
- # Values:  TEXT
- #
- failregex = \[WARNING\] sofia_reg.c:\d+ SIP auth failure \(REGISTER\) on sofia profile \'\w+\' for \[.*\] from ip <HOST>
-             \[WARNING\] sofia_reg.c:\d+ SIP auth failure \(INVITE\) on sofia profile \'\w+\' for \[.*\] from ip <HOST>
-             \[WARNING\] sofia_reg.c:\d+ SIP auth challenge \(REGISTER\) on sofia profile \'\w+\' for \[.*\] from ip <HOST>
- 
- # Option:  ignoreregex
- # Notes.:  regex to ignore. If this regex matches, the line is ignored.
- # Values:  TEXT
- #
- ignoreregex =
-
-
-| Modify /etc/fail2ban/jail.conf. Add the following make sure the freeswitch.log file path is correct.
-
-::
-
- [freeswitch-tcp]
- 
- enabled  = true
- port     = 5060,5061,5080,5081
- protocol = tcp
- filter   = freeswitch
- logpath  = /usr/local/freeswitch/log/freeswitch.log
- action   = iptables-allports[name=freeswitch-tcp, protocol=all]
-            sendmail-whois[name=FreeSwitch, dest=root, [email protected]]
- 
- [freeswitch-udp]
- 
- enabled  = true
- port     = 5060,5061,5080,5081
- protocol = udp
- filter   = freeswitch
- logpath  = /usr/local/freeswitch/log/freeswitch/freeswitch.log
- action   = iptables-allports[name=freeswitch-udp, protocol=all]
-            sendmail-whois[name=FreeSwitch, dest=root, [email protected]]
-
-
-| /var/log/fail2ban.log will log this after 3 missed logins.
-
-::
-
- 2011-02-01 12:32:18,151 fail2ban.actions: WARNING [fusionpbx] Ban 192.168.100.1
- 
-
-| hostname # iptables -n -L fail2ban-fusionpbx
-
-::
-
- Chain fail2ban-fusionpbx (1 referecnes)
- target    prot opt source        destination
- DROP      all  --  192.168.100.1 anywhere
- RETURN    all  --  anywhere      anywhere
-
-
-| **Important**
-| **You can easily ban yourself, including current active ssh connections.**
-| **To unban:**
-
-::
-
- hostname # iptables -n -D fail2ban-fusionpbx 1
-
-| **Keep yourself from getting banned.**
-| add to /etc/fail2ban/jail.local
-
-::
-
- [DEFAULT]
- 
- # "ignoreip" can be an IP address, a CIDR mask or a DNS host
- ignoreip = 127.0.0.1 192.168.0.99
- bantime  = 600
- maxretry = 3
-
-
-| **Errors**
-| If you're seeing something like this in your fail2ban logfile:
-
-::
- 
- 2011-02-27 14:11:42,326 fail2ban.actions.action: ERROR  iptables -N fail2ban-freeswitch-tcp
-
-
-| add the time.sleep(0.1) to /usr/bin/fail2ban-client
-
-::
-
- def __processCmd(self, cmd, showRet = True):
- beautifier = Beautifier()
- for c in cmd:
- '''time.sleep(0.1)'''
- beautifier.setInputCmd(c)
-
-| or
-
-::
-
- sed -i -e s,beautifier\.setInputCmd\(c\),'time.sleep\(0\.1\)\n\t\t\tbeautifier.setInputCmd\(c\)', /usr/bin/fail2ban-client
-
-| http://www.fail2ban.org/wiki/index.php/Fail2ban_talk:Community_Portal#fail2ban.action.action_ERROR_on_startup

+ 1 - 0
source/additional_information/freeswitch.rst

@@ -84,6 +84,7 @@ Freeswitch install
  mod_memcache
  mod_cidlookup
  mod_curl
+ mod_translate
 
 | Used for MP3 support
 

+ 5 - 0
source/advanced/adminer.rst

@@ -12,3 +12,8 @@ Adminer provides a way to access FusionPBX database.
         :scale: 85%
 
 *  To access Adminer goto advanced > adminer.
+
+.. Note::
+ 
+  After you enable the Adminer auto login click the reload button > edit autoload > click save for it to update the Adminer menu.
+  

+ 5 - 0
source/advanced/version_upgrade.rst

@@ -27,6 +27,11 @@ Then run Advanced -> Upgrade -> App Defaults to get new up to date diaplans.
  cd /usr/src
  wget https://raw.githubusercontent.com/fusionpbx/fusionpbx-scripts/master/upgrade/record_path.php
  php record_path.php
+ 
+Changes to Call Center will require agents to be removed and added back to the queue.
+
+* Agent > Call Center
+* Agent ID is now the agents extension number. You will need to reassign the agent to the queue.
 
 Version 4.0 to 4.2
 ^^^^^^^^^^^^^^^^^^

+ 1 - 0
source/applications.rst

@@ -29,6 +29,7 @@ In the **Applications** menu (Apps) section you will find Call Block, Call Broad
   applications/queues.rst
   applications/recordings.rst
   applications/ring_group.rst
+  applications/streams.rst
   applications/time_conditions.rst
   applications/voicemail.rst
   applications/xmpp.rst

+ 14 - 11
source/applications/provision.rst

@@ -3,20 +3,11 @@ Provision
 ************
 
 
-Manual
-^^^^^^^
-
-* `Cisco <http://docs.fusionpbx.com/en/latest/applications/provision/provision_manual_cisco.html>`_
-* `Polycom <http://docs.fusionpbx.com/en/latest/applications/provision/provision_manual_polycom.html>`_
-*  `Grandstream <http://docs.fusionpbx.com/en/latest/applications/provision/provision_manual_grandstream.html>`_
-*  `Yealink <http://docs.fusionpbx.com/en/latest/applications/provision/provision_manual_yealink.html>`_
-*  `Zoiper <http://docs.fusionpbx.com/en/latest/applications/provision/provision_manual_zoiper.html>`_
-
-
-
 Automatic
 ^^^^^^^^^^
 
+Auto provisioning is disabled by default. This is to give a chance to secure provisioning server with HTTP Authentication or CIDR. HTTP Authentication requires the phone to send hash of the combined username and password in order to get configuration. CIDR is an IP address restriction that can be used to restrict which IP addresses are allowed to get the device configuration. An example of CIDR is xxx.xxx.xxx.xxx/32 the /32 represents a single IP address. To set one of these values go to Advanced > Default Settings and find the Provision category from there used the edit button to set a value. After this is done it is safe to set enabled equal to true.
+
 *  `Cisco <http://docs.fusionpbx.com/en/latest/applications/provision/provision_auto_cisco.html>`_
 *  `Polycom <http://docs.fusionpbx.com/en/latest/applications/provision/provision_auto_polycom.html>`_
 *  `Grandstream <http://docs.fusionpbx.com/en/latest/applications/provision/provision_auto_grandstream.html>`_
@@ -24,6 +15,18 @@ Automatic
 *  `Zoiper <http://docs.fusionpbx.com/en/latest/applications/provision/provision_auto_zoiper.html>`_
 
 
+Manual
+^^^^^^^
+
+How to setup the device using the phone's web interface.
+
+* `Cisco <http://docs.fusionpbx.com/en/latest/applications/provision/provision_manual_cisco.html>`_
+* `Polycom <http://docs.fusionpbx.com/en/latest/applications/provision/provision_manual_polycom.html>`_
+*  `Grandstream <http://docs.fusionpbx.com/en/latest/applications/provision/provision_manual_grandstream.html>`_
+*  `Yealink <http://docs.fusionpbx.com/en/latest/applications/provision/provision_manual_yealink.html>`_
+*  `Zoiper <http://docs.fusionpbx.com/en/latest/applications/provision/provision_manual_zoiper.html>`_
+
+
 Phone Screen Capture
 ^^^^^^^^^^^^^^^^^^^^^
 

+ 0 - 2
source/applications/provision/provision_auto_yealink.rst

@@ -1,8 +1,6 @@
 Yealink Automatic Provision
 ============================
 
-Make sure that provisioning is enabled, http_auth_password is set, and http_auth_username is set on your FusionPBX install by going to the Advanced > Default Settings > Provision section.
-
 
 To auto provision Yealink
 

+ 6 - 0
source/applications/streams.rst

@@ -0,0 +1,6 @@
+###########
+Streams
+###########
+
+Define details for streaming audio.
+

+ 0 - 2
source/applications/voicemail.rst

@@ -115,8 +115,6 @@ If you entered your key's correctly, you should now start getting transcriptions
 +---------------------------+----------------+
 | vm_say_date_time          | true or false  |
 +---------------------------+----------------+
-| vm_say_date_time          | true or false  |
-+---------------------------+----------------+
 | skip_greeting             | true or false  |
 +---------------------------+----------------+
 | skip_instructions         | true or false  |

+ 11 - 11
source/applications_optional/xmpp.rst

@@ -9,7 +9,7 @@ XMPP Manager
 
 |
 
-| 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.
+| XMPP Manager is an optional menu item.  In order to have the option for XMPP Manager, there are a few steps you need to take to enable it.
 
 |
 
@@ -31,7 +31,7 @@ XMPP Manager
         
 | on the right to create a profile.         
 
-| In this example we will setup Google Talk and by creating a profile called gtalk. 
+| In this example we will setup Google Talk by creating a profile called gtalk. 
 
 ::
 
@@ -77,10 +77,10 @@ XMPP Manager
  Default extension: 1001
  Advanced -> Context: your.domain.com
 
-| Save the settings and restart the module. Restart the 'XMPP' module from Advanced -> Modules page. 
-| Go back to Accounts -> XMPP if the status says **'AUTHORIZED'** then you are ready to go.
+| Save the settings and restart the module from Advanced -> Modules page. 
+| Go back to Accounts -> XMPP if the status says **'AUTHORIZED'** then you are ready to go!
 
-| **Note** If you are not getting AUTHORIZED you might need to goto the google account settings and choose "Allow less secure apps: ON" under the Sign-in & security section.
+| **Note** If you are not getting AUTHORIZED you might need to go to the google account settings and choose "Allow less secure apps: ON" under the Sign-in & security section. (https://support.google.com/accounts/answer/6010255?hl=en)
 
 |
 
@@ -119,7 +119,7 @@ Enable XMPP
 |
 | After version 3.8 XMPP is optional.  To add XMPP do the following
 
-| Goto command line
+| Go to command line
 
 ::
 
@@ -132,18 +132,18 @@ Enable XMPP
 
 
 
-Goto Fusionpbx GUI
+Login to FusionPBX
 
-| Goto the GUI and click advanced > menu manager > edit icon > click "Restore Defaults" at top right
+| Go to the GUI and click Advanced > Menu Manager > edit icon > click "Restore Defaults" at top right
 |
 
-| Then goto Advanced > Upgrade click Schema, Data Types, and Permission Defaults then click execute
+| Then go to Advanced > Upgrade click Schema, Data Types, and Permission Defaults then click execute
 
 |
-| Click status > sip status > Flush Memcache
+| Click Status > SIP Status > Flush Memcache
 
 |
-| Log out then back in
+| Log out then log back in
 
 |
 | You should now have XMPP Manager under Accounts

+ 40 - 17
source/firewall/fail2ban.rst

@@ -8,7 +8,7 @@ Fail2ban is also used to protect SSH, FreeSWITCH, the web server as well as othe
 
 ::
  
- iptables -L
+ iptables -L -n
  
 
 To check the status of one of the fail2ban jails
@@ -16,36 +16,59 @@ To check the status of one of the fail2ban jails
 ::
 
  fail2ban-client status freeswitch-ip-tcp
- 
-This command will show
+
+
+Fail2ban configuration files are located in.
 
 ::
 
-` Status for the jail: freeswitch-ip-tcp
-` |- filter
-` |  |- File list:        /usr/local/freeswitch/log/freeswitch.log
-` |  |- Currently failed: 0
-` |  `- Total failed:     4
-` `- action
-`  |- Currently banned: 3
-`  |  `- IP list:       207.38.90.177 51.15.145.32 207.38.90.197
-`   `- Total banned:     3
+ cd /etc/fail2ban/
+
+
+To exclude an IP so that it isn't blocked by any filters edit the **jails.conf** file.
 
-To exclude an ip so that it isn't blocked by any filters edit the **jails.conf** file.
 
 ::
 
  nano /etc/fail2ban/jail.conf
 
 
-Find ignoreip = and place domain.tld or 000.000.000.000.  Just put a space between them.
+Find ignoreip and add the IP address, CIDR or DNS hostname that need to be white listed. Use a space as a delimitter between each one. Restart fail2ban to apply the changes to the ignoreip list.
 
 ::
 
- ignoreip = domain.tld 000.000.000.000 192.168.0.0/16
- 
+ ignoreip = 127.0.0.1/8 192.168.0.0/16
+
+
+Filters are defined in the following directory.
+
+::
+
+ /etc/fail2ban/filter.d
+
+
+Inside jail.local points to filters and defines maxretry, bantime, logpath, ports to block and more.
+
+::
+
+ /etc/fail2ban/jail.local
+
+
+Clear all blocked addresses by restarting fail2ban.
+
+::
+
+  service fail2ban restart
+
+
+Fail2ban logs the addresses that it blocks with the filter that triggered it.
+
+::
+
+  /var/log/fail2ban.log
+
 
-More about whitelisting can be found at http://www.fail2ban.org/wiki/index.php/Whitelist
+More information about Fail2ban can be found at http://www.fail2ban.org/wiki
 
 
 .. Note::

+ 1 - 1
source/getting_started/security.rst

@@ -91,4 +91,4 @@ Use strong passwords with SSH or even better use SSH keys for better protection
 .. _Verto Communicator: https://freeswitch.org/confluence/display/FREESWITCH/Verto+Communicator
 .. _Setup Let's Encrypt with FusionPBX: /en/latest/getting_started/lets_encrypt.html
 .. _Let's Encrypt: https://letsencrypt.org/docs
-.. _Fail2ban: /en/latest/firewall/fail2ban.html
+.. _Fail2ban: /en/latest/additional_information/fail2ban.html

+ 1 - 1
source/status/active_queues.rst

@@ -2,5 +2,5 @@
 Active Queues
 ************
 
-| List all the queues that are currently active with one or more callers.
+Queues feature generates a dialplan that uses mod_fifo. FIFO stands for 'first in first out' in other words a queue.
 

+ 13 - 0
source/status/cdr_statistics.rst

@@ -13,3 +13,16 @@ Call Detail Records Statics summarize the call information.
         :scale: 85%
 
 
+Definitions
+^^^^^^^^^^^
+
+* Hours: Specific hour in that day.
+* Date: Specific date in that month.
+* Time: Specific time in that day.
+* Volume: Number of calls.
+* Minutes: Specific number of minutes.
+* Calls Per Minute: Specific number of calls per minute.
+* Missed: Specific number of missed calls.
+* ASR: The answer to seizure ratio. Which is how many calls where answered versus not answered.
+* Aloc:  ALOC is the average length of call.
+* Days: Specific day in that month.

+ 15 - 0
source/status/extension_summary.rst

@@ -8,3 +8,18 @@ Summary of extension activity per domain such as misssed calls, answered calls,
 
 .. image:: ../_static/images/fusionpbx_extension_summary.jpg
         :scale: 85%
+
+
+Definitions
+^^^^^^^^^^^
+
+* Extension: The extension number.
+* Number Alias: Alias name for the extension number.
+* Missed: Number of missed calls.
+* No Answer: Number of calls not answered.
+* Busy: Number of calss not answered wile busy.
+* ALOC: The average length of call.
+* Inbound Calls: Number of calls in.
+* Inbound Duriation: Number of call minutes in. 
+* Outbound Calls: Number of calls out.
+* Outbound Duriation: Number of call minutes out.