external/iiab
1
0
Fork 0
mirror of https://github.com/iiab/iiab.git synced 2025-02-13 03:32:12 +00:00
Code Issues Releases Wiki Activity

pbx/README.adoc: Clarifs & try numbered lists

Browse source
This commit is contained in:
A Holt 2021-08-14 07:54:13 -04:00 committed by GitHub
parent 548ad8abe9
commit f6987299a9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
roles/pbx/README.adoc
View file

@ -20,37 +20,39 @@ https://en.wikipedia.org/wiki/FreePBX[FreePBX] is a web-based open source GUI (g
=== Install it
Make sure your IIAB configuration file (http://wiki.laptop.org/go/IIAB/FAQ#What_is_local_vars.yml_and_how_do_I_customize_it.3F[/etc/iiab/local_vars.yml]) contains:
. _Before installing,_ make sure your IIAB configuration file (http://wiki.laptop.org/go/IIAB/FAQ#What_is_local_vars.yml_and_how_do_I_customize_it.3F[/etc/iiab/local_vars.yml]) contains:
+
----
pbx_install: True
pbx_enabled: True
----
You have the option of using the Apache (default) or NGINX web server. To use NGINX, include this line in your http://wiki.laptop.org/go/IIAB/FAQ#What_is_local_vars.yml_and_how_do_I_customize_it.3F[/etc/iiab/local_vars.yml] file:
+
You have the option of using Apache on port 83 (default) or NGINX on port 80, as the web server for FreePBX. To use NGINX, include this line in your http://wiki.laptop.org/go/IIAB/FAQ#What_is_local_vars.yml_and_how_do_I_customize_it.3F[/etc/iiab/local_vars.yml] file:
+
----
pbx_try_nginx: True
----
If using PBX intensively, please adjust `/etc/php/X.Y/apache2/php.ini`, `/etc/php/X.Y/cli/php.ini` and/or `/etc/php/X.Y/nginx/php.ini` (where `X.Y` is typically 7.4) as outlined within https://github.com/iiab/iiab/blob/master/roles/www_options/tasks/main.yml#L88-L131[/opt/iiab/iiab/roles/www_options/tasks/main.yml] — some of which happens automatically if you've also set:
+
If using PBX intensively, please adjust `/etc/php/X.Y/apache2/php.ini`, `/etc/php/X.Y/cli/php.ini` and/or `/etc/php/X.Y/nginx/php.ini` (where `X.Y` is typically 7.4) as outlined within https://github.com/iiab/iiab/blob/master/roles/www_options/tasks/main.yml#L88-L131[/opt/iiab/iiab/roles/www_options/tasks/main.yml] — some of which happens automatically if you also set:
+
----
nginx_high_php_limits: True
----
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:
+
Optionally, you may want to enable https://github.com/wdoekes/asterisk-chan-dongle[chan_dongle], which is a channel driver for Huawei UMTS cards (e.g. 3G USB dongles) allowing regular voice calls over GSM mobile networks. 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:
. _Complete the installation of IIAB and this https://github.com/iiab/iiab/tree/master/roles/pbx[roles/pbx] Ansible playbook,_ proceeding with the regular instructions (http://download.iiab.io[download.iiab.io]).
. After IIAB is installed with Asterisk and FreePBX, verify that FreePBX service is running, by 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 <<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!)
@ -59,15 +61,17 @@ If FreePBX is not running well, check the long-form output of `journalctl -u fre
=== Try it out with an Android or iPhone softphone (SIP) app
// SIP Set up a basic working FreePBX configuration with a PJSIP extension
==== Initial Configuration
. Log in to FreePBX
+
// After installing PBX as part of IIAB, please
Browse to 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!)
// You will be asked to set up your username and password the first time you login, which will be used in future to log in for FreePBX configuration.
+
To log in, click the first option: *FreePBX Administration*
+
If you forgot your FreePBX password, see <<#Password_Recovery,further below>>.
==== Change your Asterisk password, if you choose
. Change your Asterisk password, if you choose
* Click *Settings* > *Advanced Settings*
** In section *Asterisk Manager*, change your *Asterisk Manager Password*
@ -75,7 +79,7 @@ To log in, click the first option: *FreePBX Administration*
+
image::files/advanced_settings.jpg[]
==== Change Asterisk SIP settings
. Set Network NAT Settings
* Go to *Settings* > *Asterisk SIP settings*
@ -86,7 +90,7 @@ image::files/advanced_settings.jpg[]
+
image::files/asterisk_sip_settings.jpg[]
==== Create SIP phone extensions, so you can make calls
. Create SIP phone extensions, so you can make calls
* Go to *Applications* > *Extensions* > *Add Extension* > *Add New SIP [chan_pjsip] Extension*, and create a phone extension (local phone number) such as the following:
@ -101,8 +105,8 @@ image::files/add_extn_01_top.jpg[]
+
image::files/add_extn_02.jpg[]
==== Register the extension, on your smartphone or laptop
. Register the extension, on your smartphone or laptop
+
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
@ -122,7 +126,7 @@ image::files/linphone_setup.jpg[width='33%']
+
image::files/linphone_connected.jpg[width='33%']
* 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).
* _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`
@ -137,7 +141,7 @@ image::files/linphone_connected.jpg[width='33%']
* The number of v's denotes the verbosity level. In this case, it is 3.
* If Asterisk is running, it'll take you to the Asterisk CLI (command-line interface).
. If you see _Asterisk is not connected_ in red within FreePBX's web interface, check that Asterisk is running using Linux command `pgrep asterisk`. You should see at least 2 different process numbers. If not, please restart Asterisk using Linux command: `sudo fwconsole restart`
. If you see _Asterisk is not connected_ in red within FreePBX's web interface, check that Asterisk is running using Linux command `sudo pgrep asterisk`. You should see at least 2 different process numbers. If not, please restart Asterisk using Linux command: `sudo fwconsole restart`
. Check all log files carefully, within this directory:
+
@ -171,7 +175,7 @@ sudo fwconsole reload
. To run an Asterisk command outside of Asterisk's CLI, e.g. for use in a script:
* Try Linux commands like:
* Exit the Asterisk CLI, and try Linux commands like:
+
----
asterisk -rx "pjsip show endpoints"
@ -207,7 +211,7 @@ sudo fwconsole ma upgradeall # Upgrade your FreePBX modules (as normally
* If you'd like to allow users more control over their own settings, and the ability to review their own statistics, install the https://wiki.freepbx.org/pages/viewpage.action?pageId=28180526[User Control Panel] FreePBX module from http://box.lan:83/freepbx or http://box.lan/freepbx > *Admin* > *Module Admin* > *Check Online*.
. If you forget your FreePBX password, you can bypass it using Linux command `sudo fwconsole unlock <Session ID>` and then refresh your FreePBX web page.
. [[Password_Recovery]]If you forget your FreePBX password, you can bypass it using Linux command `sudo fwconsole unlock <Session ID>` and then refresh your FreePBX web page.
+
To get the Session ID, press `Ctrl + a` which will highlight all the text on the page. The text highlighted in the middle of the page, is the Session ID:
+