mirror of
https://github.com/iiab/iiab.git
synced 2025-02-15 04:32:11 +00:00
pbx/README.adoc: Touchups, punctuation, etc
This commit is contained in:
A Holt
GitHub
parent
b20f359849
commit
5d0eca874d
1 changed files with 35 additions and 23 deletions
|
|
@ -1,6 +1,6 @@
|
|||
== PBX README
|
||||
|
||||
IIAB can install https://asterisk.org/[Asterisk] and https://freepbx.org/[FreePBX] to Internet-in-a-Box (IIAB) for Voice over IP (VoIP) calls using regular Android and iPhone softphone (SIP) apps, e.g. for low-cost and rural telephony.
|
||||
https://internet-in-a-box.org[Internet-in-a-Box (IIAB)] can install https://asterisk.org/[Asterisk] and https://freepbx.org/[FreePBX] for Voice over IP (VoIP) calls using regular Android and iPhone softphone (SIP) apps — e.g. for low-cost and rural telephony.
|
||||
|
||||
As of August 2021, IIAB installs https://wiki.asterisk.org/wiki/display/AST/Asterisk+18+Documentation[Asterisk 18] and https://www.freepbx.org/freepbx-16-beta-is-here/[FreePBX 16 Beta], as required by the latest PHP 7.4 Linux OS's (https://github.com/iiab/iiab/pull/2899[PR #2899]). Please consider installing this on https://github.com/iiab/iiab/wiki/IIAB-Platforms#operating-systems[Ubuntu 20.04+, Debian 11 — or the imminent Raspberry Pi OS 11 "Bullseye"].
|
||||
|
||||
|
|
@ -13,7 +13,7 @@ _Historical:_ Back in February 2019, IIAB had installed Asterisk 16 and FreePBX
|
|||
|
||||
=== What Asterisk & FreePBX do
|
||||
|
||||
https://en.wikipedia.org/wiki/Asterisk_(PBX)[Asterisk] is a software implementation of a private branch exchange (PBX). In conjunction with suitable telephony hardware interfaces and network applications, Asterisk is used to establish and control telephone calls between telecommunication endpoints, such as customary telephone sets, destinations on the public switched telephone network (PSTN), and devices or services on Voice over Internet Protocol (VoIP) networks. Its name comes from the asterisk (*) symbol for a signal used in dual-tone multi-frequency (DTMF) dialing.
|
||||
https://en.wikipedia.org/wiki/Asterisk_(PBX)[Asterisk] is a software implementation of a private branch exchange (PBX). In conjunction with suitable IP telephony hardware interfaces and network applications, Asterisk is used to establish and control telephone calls between telecommunication endpoints, such as customary telephone sets, destinations on the public switched telephone network (PSTN), and devices or services on Voice over Internet Protocol (VoIP) networks. Its name comes from the asterisk (*) symbol for a signal used in dual-tone multi-frequency (DTMF) dialing.
|
||||
|
||||
https://en.wikipedia.org/wiki/FreePBX[FreePBX] is a web-based open source GUI (graphical user interface) that controls and manages Asterisk (PBX), the open source communications server.
|
||||
|
||||
|
|
@ -39,18 +39,20 @@ If using PBX intensively, please adjust `/etc/php/X.Y/apache2/php.ini`, `/etc/ph
|
|||
nginx_high_php_limits: True
|
||||
----
|
||||
|
||||
To verify the FreePBX service is running, you can run this at the command-line:
|
||||
|
||||
----
|
||||
systemctl status freepbx
|
||||
----
|
||||
|
||||
Optionally, you may want to enable https://github.com/wdoekes/asterisk-chan-dongle[chan_dongle], which is a channel driver for Huawei UMTS cards allowing regular voice calls over GSM. You will need to configure a dongle post-install, for it to be recognized properly:
|
||||
|
||||
----
|
||||
asterisk_chan_dongle: True
|
||||
----
|
||||
|
||||
After IIAB is installed with Asterisk and FreePBX, verify that FreePBX service is running, running this at the command-line:
|
||||
|
||||
----
|
||||
systemctl status freepbx
|
||||
----
|
||||
|
||||
If FreePBX is not running well, check the long-form output of `journalctl -u freepbx` and the link:README.adoc#Troubleshooting[Troubleshooting] section further below.
|
||||
|
||||
// After installing PBX as part of IIAB, please visit http://box.lan:83/freepbx (Apache) or http://box.lan/freepbx (NGINX) and proceed with initial configuration (no login/password is required initially — you will be asked to set this up!)
|
||||
|
||||
|
||||
|
|
@ -76,18 +78,22 @@ image::files/advanced_settings.jpg[]
|
|||
==== Change Asterisk SIP settings
|
||||
|
||||
* Go to *Settings* > *Asterisk SIP settings*
|
||||
** In section *NAT Settings*, click *Detect Network Settings* to populate your *External Address* and *Local Networks*
|
||||
** Under *Local Networks*, you can also manually set an IP/CIDR (e.g. `192.168.0.0/24`) or an IP/NETMASK (e.g. `192.168.0.0/255.255.255.0`)
|
||||
|
||||
** In section *NAT Settings*, click *Detect Network Settings* to populate your *External Address* and *Local Networks*.
|
||||
** Under *Local Networks*, you can also manually set an IP/CIDR (e.g. `192.168.0.0/24`) or an IP/NETMASK (e.g. `192.168.0.0/255.255.255.0`).
|
||||
|
||||
* Click *Submit* (bottom of page), then *Apply Config* (top of page)
|
||||
+
|
||||
image::files/asterisk_sip_settings.jpg[]
|
||||
|
||||
==== Create SIP phone extensions, so you can make calls
|
||||
|
||||
* Go to *Applications* > *Extensions* > *Add Extension* > *Add New SIP [chan_pjsip] Extension*, and enter an extension (local phone number) such as the following:
|
||||
** *User Extension*: _301_
|
||||
** *Display Name*: _John Doe_
|
||||
** *Secret*: _strong password_
|
||||
* Go to *Applications* > *Extensions* > *Add Extension* > *Add New SIP [chan_pjsip] Extension*, and create a phone extension (local phone number) such as the following:
|
||||
|
||||
** *User Extension*: _301_
|
||||
** *Display Name*: _John Doe_
|
||||
** *Secret*: _y0ur 0wn $tr0ng p4ssw0rd_
|
||||
|
||||
* Click *Submit* (bottom of page), then *Apply Config* (top of page)
|
||||
* Using the same steps, create extensions for every user!
|
||||
+
|
||||
|
|
@ -97,14 +103,16 @@ image::files/add_extn_02.jpg[]
|
|||
|
||||
==== Register the extension, on your smartphone or laptop
|
||||
|
||||
You can now register the extensions using a softphone (SIP) app on your smartphone. In this example we will use the https://en.wikipedia.org/wiki/Linphone[Linphone] app, on an Android phone. After you open the app, follow these steps:
|
||||
You can now register the extension using a softphone (SIP) app on your smartphone or laptop. In this example we will use the https://en.wikipedia.org/wiki/Linphone[Linphone] app, on an Android phone. After you open the app, follow these steps:
|
||||
|
||||
* Connect your smartphone or laptop to the *Internet in a Box* WiFi hotspot
|
||||
* Select *USE SIP ACCOUNT*
|
||||
* Enter those same details that you entered above into the FreePBX console website:
|
||||
** *Username* is the same as _User Extension_
|
||||
** *Password* is the same as _Secret_
|
||||
** *Domain* is your IIAB server's IP address
|
||||
* Enter those same details that you entered above into the FreePBX administration website:
|
||||
|
||||
** *Username* is the same as above *User Extension*
|
||||
** *Password* is the same as above *Secret*
|
||||
** *Domain* is your IIAB server's IP address
|
||||
|
||||
* Select *UDP* under *Transport*
|
||||
* Select *LOGIN*
|
||||
+
|
||||
|
|
@ -114,7 +122,11 @@ image::files/linphone_setup.jpg[width='33%']
|
|||
+
|
||||
image::files/linphone_connected.jpg[width='33%']
|
||||
|
||||
* If you have created more than one extension, make a call to another extension. You will see activity in the *FreePBX Statistics* applet on your http://box.lan:83/freebx (or http://box.lan/freebx) Dashboard. Connection details may also be seen in the Asterisk logs at: `/var/logs/asterisk/full`
|
||||
* If you've created more than one extension, make a call to another extension. If you've not yet made more than one extension, try calling an arbitrary extension, or try calling your own extension (your own phone number).
|
||||
|
||||
** You should see activity in the *FreePBX Statistics* applet at http://box.lan:83/freebx (or http://box.lan/freebx) > *Dashboard*
|
||||
** Connection details may also be seen in the Asterisk logs at: `/var/logs/asterisk/full`
|
||||
** Please create a https://en.wikipedia.org/wiki/Privacy_policy[Privacy Policy] against abusive surveillance, and explain it to the people in your community. Strongly consider giving them access to their own statistics with the link:README.adoc#User_Control_Panel[User Control Panel] explained further below.
|
||||
|
||||
|
||||
=== Troubleshooting
|
||||
|
|
@ -131,14 +143,14 @@ image::files/linphone_connected.jpg[width='33%']
|
|||
|
||||
/var/log/asterisk/
|
||||
|
||||
. If you see an _fwconsole read_ error when you save settings, try to run Linux command `sudo fwconsole chown` followed by `sudo fwconsole reload`
|
||||
. If you see an _fwconsole read_ error when you save FreePBX settings, try to run Linux command `sudo fwconsole chown` followed by `sudo fwconsole reload`
|
||||
|
||||
=== Some useful Asterisk commands
|
||||
|
||||
. To reach Asterisk's own CLI (command-line interface)
|
||||
|
||||
* Run Linux command: `sudo asterisk -rvvvv`
|
||||
* Note: The number of v's denote the verbosity level. In this case, it is 4.
|
||||
* Note: The number of v's denotes the verbosity level. In this case, it is 4.
|
||||
|
||||
. To see all available Asterisk commands:
|
||||
|
||||
|
|
@ -164,7 +176,7 @@ image::files/pwdless_login.jpg[]
|
|||
+
|
||||
image::files/password_change.jpg[]
|
||||
|
||||
. User Control Panel
|
||||
. [[User_Control_Panel]]https://wiki.freepbx.org/pages/viewpage.action?pageId=28180526[User Control Panel]
|
||||
|
||||
* If you'd like to allow users to manage some of their own settings and view their statistics, install the *User Control Panel* FreePBX module from *Admin* > *Module Admin* > *Check Online*.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue