VitalPBX – VitalPBX Wiki https://wiki.vitalpbx.org Learn how our latest VitalPBX version will enhance your business communication Mon, 18 Dec 2023 15:44:02 +0000 en-US hourly 1 https://wordpress.org/?v=6.5.2 https://wiki.vitalpbx.org/wp-content/uploads/2023/11/cropped-vitalbpxwikiicon-8-32x32.png VitalPBX – VitalPBX Wiki https://wiki.vitalpbx.org 32 32 Appendix https://wiki.vitalpbx.org/wiki/appendix/appendix/ https://wiki.vitalpbx.org/wiki/appendix/appendix/#respond Mon, 18 Dec 2023 14:11:33 +0000 https://wiki.vitalpbx.org/?post_type=docs&p=2702 Resources

VitalPBX Technical FAQ –https://wiki.vitalpbx.com/wiki-category/faq/

]]>
https://wiki.vitalpbx.org/wiki/appendix/appendix/feed/ 0
Grand Conclusion https://wiki.vitalpbx.org/wiki/appendix/grand-conclusion/ https://wiki.vitalpbx.org/wiki/appendix/grand-conclusion/#respond Mon, 18 Dec 2023 14:10:58 +0000 https://wiki.vitalpbx.org/?post_type=docs&p=2700 Congratulations! With this, we come to an end with the VitalPBX Complete Guide and Manual. The manual covered everything you need to know about VitalPBX, how to configure it, and have your VitalPBX completely set up. We appreciate you choosing VitalPBX for your business endeavors, and we hope to hear more about you.

If you ever have any comments or questions, send us an email to sales@vitalpbx.com and we will gladly guide you to the right place.

]]>
https://wiki.vitalpbx.org/wiki/appendix/grand-conclusion/feed/ 0
Conclusion https://wiki.vitalpbx.org/wiki/troubleshooting/conclusion-16/ https://wiki.vitalpbx.org/wiki/troubleshooting/conclusion-16/#respond Mon, 18 Dec 2023 14:10:23 +0000 https://wiki.vitalpbx.org/?post_type=docs&p=2698 With these tips and tricks, you can monitor and manage your VitalPBX instance and troubleshoot for any errors. By following this manual, you know where to tackle any issue if you find what is happening during the situation.

]]>
https://wiki.vitalpbx.org/wiki/troubleshooting/conclusion-16/feed/ 0
VitalPBX Commands https://wiki.vitalpbx.org/wiki/troubleshooting/vitalpbx-commands/ https://wiki.vitalpbx.org/wiki/troubleshooting/vitalpbx-commands/#respond Mon, 18 Dec 2023 14:09:52 +0000 https://wiki.vitalpbx.org/?post_type=docs&p=2693 With VitalPBX, we have created multiple commands you can run from the Linux CLI, that can help you manage and stabilize your VitalPBX installation. Here are all the VitalPBX Commands you can run.

To see the list of available commands, run the following command.

To reset the password for any Web UI user, run the following command.

Where [username] is the user you wish to change the password.

To rebuild the VitalPBX database, run the following command.

This will execute a series of scripts to build the VitalPBX database.

To generate the Asterisk configurations and rebuild the Asterisk database for the main tenant only, we run the following command.

To generate the Asterisk configurations and rebuild the Asterisk database for all tenants, we run the following command.

To check for any issues regarding directories/files and their permissions and owners, we run the following command.

To apply the changes made on the Firewall module on VitalPBX, we run the following command.

You can manually restore from a backup file you have uploaded manually by running the following command.

This is especially useful when the backup file is too big to upload from the web interface. You can upload it manually using an SCP or SFTP application to your VitalPBX, then run the command and specify the path to the backup file to restore the system from it.

To reset the SSL certificates and disable the force HTTPS option, run the following command.

This will help you in case your SSL certificate expires or you don’t have access to your server via HTTPS.

To optimize the performance of MariaDB/MySQL, you can run the following command.

Keep in mind that this will restart MariaDB.

To optimize the Apache configurations on your VitalPBX, run the following command.

To disable 2FA for a user, run the following command.

With this, you can disable 2FA for a specific user in case they lose access to their 2FA application. You can use either their username or email address.

To update VitalPBX and all its dependencies, run the following command.

With this, you can control your VitalPBX installation from the command line and troubleshoot any issues you may have.

]]>
https://wiki.vitalpbx.org/wiki/troubleshooting/vitalpbx-commands/feed/ 0
SNGrep https://wiki.vitalpbx.org/wiki/troubleshooting/sngrep/ https://wiki.vitalpbx.org/wiki/troubleshooting/sngrep/#respond Mon, 18 Dec 2023 14:05:49 +0000 https://wiki.vitalpbx.org/?post_type=docs&p=2680 A more advanced way to trace events on your VitalPBX is using SNGrep. SNGrep is a tool that allows you to monitor SIP/PJSIP events on your VitalPBX. Here, you can see detailed information for your registrations, RTP traffic, and notices of devices and trunks connected to your VitalPBX. SNGrep is installed as one of the dependencies for VitalPBX. You can run the following command to see the available attributes on the application.

To run SNGrep simply enter the following command.

This will show you the SNGrep interface.

Here, you will see a list of events occurring on your VitalPBX. You can navigate the list of events using the arrow keys. You can enter an event by pressing the Enter key on your keyboard. This will show you all the details of the event. You can navigate the stages using the keyboard. This will show you all the details of the event. You can navigate the stages using the arrow keys.

This will help you get direct information on the current status of your devices, calls, and registration.

You will see that we will have a lot of information that is constantly being sent on the main list of events. For this, we can filter our list to see only the events we are interested in. So, on the main page for SNGrep, press the F7 key on your keyboard. This will show you a prompt where you can filter the events by the SIP From and To, Source and Destination, and Payload. You can also apply a filter by the type of event you want to monitor.

With your filters set, navigate with the arrow keys to Filter and press Enter on your keyboard.

You will see that the list of events will now show the events related to your filter.

This is a great tool for you to troubleshoot the SIP/PJSIP events on your VitalPBX. To quit the SNGrep interface press the Escape key on your keyboard and then select Exit by pressing the Enter key on your keyboard.

]]>
https://wiki.vitalpbx.org/wiki/troubleshooting/sngrep/feed/ 0
Call Filter https://wiki.vitalpbx.org/wiki/troubleshooting/call-filter/ https://wiki.vitalpbx.org/wiki/troubleshooting/call-filter/#respond Mon, 18 Dec 2023 13:59:28 +0000 https://wiki.vitalpbx.org/?post_type=docs&p=2678 When troubleshooting a call process we always go to the Asterisk CLI first to see if we are receiving the calls and trace the call to see what is the outcome that we get. We use the following command to get to the Asterisk CLI.

Or simply

However, monitoring the Asterisk CLI with high verbosity while the system is under production can show us a lot of information at a very fast pace. For this, we can filter out the Full log for Asterisk to trace actions that affect a particular call only.

We start by running the following command.

Where {PHONE_NUMBER} is a particular phone number you want to trace within the full log. Remember that you don’t have to include the curly braces. For example, you will enter something like this.

root@debian:~# tail -f /var/log/asterisk/full | grep 15554846868

In the beginning, you may see nothing if information including this number has not been set. Once any activity starts that includes this phone number you will start to see anything related to it.

This phone number you monitor can be an external number calling into your VitalPBX and you want to see the route it uses. Or it can be a DID on your system and you want to see that it is used appropriately for your inbound routes. This can help you monitor how your VoIP provider sends your DID information so you can enter it correctly on your Inbound Routes. It can also be a specific Extension Number you want to monitor their current call. Use this option to make your call troubleshooting easier during active hours on your VitalPBX.

]]>
https://wiki.vitalpbx.org/wiki/troubleshooting/call-filter/feed/ 0
Fail2Ban Commands https://wiki.vitalpbx.org/wiki/troubleshooting/fail2ban-commands/ https://wiki.vitalpbx.org/wiki/troubleshooting/fail2ban-commands/#respond Mon, 18 Dec 2023 13:57:48 +0000 https://wiki.vitalpbx.org/?post_type=docs&p=2676 Sometimes you might get blocked by the Intrusion Detection system. This can be due to a device using the wrong password to register, and this blocks you out. Or, the wrong password is entered too many times through the Web UI. We recommend you whitelist your known IP addresses through the Firewall Whitelist. But in the case, you have been blocked and you have access to the Linux terminal, here are some commands for Fail2Ban that you can use to manage the intrusion detection system from a command line level.

To see the possible Fail2Ban commands, run the following command from the Linux Command Line.

To see the clients that have been banned due to too many failed attempts through SSH, run the following command.

root@debian:~# fail2ban-client status sshd

To see the clients that have been banned due to too many failed attempts to register through Asterisk, run the following command.

To unban an IP Address, run the following command.

Where {IP_ADDRESS} is the exact IP address to unban. Do not include the curly braces.

To ban an IP address, run the following command.

root@debian:~# fail2ban-client set sshd banip {IP_ADDRESS}

Where {IP_ADDRESS} is the exact IP address to ban. Do not include the curly braces.

To block an IP address using IPTables, run the following command.

root@debian:~# iptables -I INPUT 1 -s IPAddress -j DROP

To unblock an IP address using IPTables, run the following command.

root@debian:~# iptables -D INPUT -s IPAddress -j DROP

Using these commands you can manage the Intrusion Detection system directly through the Linux Command Line.

]]>
https://wiki.vitalpbx.org/wiki/troubleshooting/fail2ban-commands/feed/ 0
Introduction https://wiki.vitalpbx.org/wiki/troubleshooting/introduction-27/ https://wiki.vitalpbx.org/wiki/troubleshooting/introduction-27/#respond Mon, 18 Dec 2023 13:54:50 +0000 https://wiki.vitalpbx.org/?post_type=docs&p=2674 Up to now, we have covered every single module VitalPBX offers. We don’t always have smooth sailing as we can make mistakes during the configuration process. Here are some of the most common and useful ways to troubleshoot your VitalPBX installation.

]]>
https://wiki.vitalpbx.org/wiki/troubleshooting/introduction-27/feed/ 0
AMI (Asterisk Management Interface) https://wiki.vitalpbx.org/wiki/api-and-ami/ami-asterisk-management-interface/ https://wiki.vitalpbx.org/wiki/api-and-ami/ami-asterisk-management-interface/#respond Mon, 18 Dec 2023 13:52:44 +0000 https://wiki.vitalpbx.org/?post_type=docs&p=2671 Another way to integrate third-party applications is using the AMI or Asterisk Management Interface. This way, you can connect directly to the Asterisk layer VitalPBX uses and monitor and manage Asterisk directly. This is useful if you require real-time information to trigger events or monitor information on a third-party application.

You can see the full AMI documentation on the following link.

https://docs.asterisk.org/Configuration/Interfaces/Asterisk-Manager-Interface-AMI/ To create an AMI user in VitalPBX, go to Settings > PBX Settings > AMI Users. Here, you will create the AMI users that will connect directly with Asterisk.

You will need to define an AMI User and Secret. We generate a random password, and we recommend you use this randomly generated password for the best security. You will also need to enter a description to identify this user.

We also require you to use the Deny and Permit options for this user. With these fields, you specify the IP address or Network segment that can access Asterisk using this AMI user. It is important that you only allow the specific IP addresses that can connect to Asterisk using this AMI user as this is an extremely permissive user. An AMI user can affect your Asterisk directly, so we need to take all the precautions necessary.

You can also limit the read and write permissions, so the AMI users are only able to perform the tasks you need for your third-party application integration.

With everything set, you can Save and then Apply Changes.

With this, you are now able to connect directly with Asterisk and monitor and manage the Asterisk layer for VitalPBX from a third-party application.

]]>
https://wiki.vitalpbx.org/wiki/api-and-ami/ami-asterisk-management-interface/feed/ 0
API https://wiki.vitalpbx.org/wiki/api-and-ami/api/ https://wiki.vitalpbx.org/wiki/api-and-ami/api/#respond Mon, 18 Dec 2023 13:49:07 +0000 https://wiki.vitalpbx.org/?post_type=docs&p=2668 Admin […]]]> VitalPBX has an API that allows you to retrieve information from VitalPBX and any of its tenants. The VitalPBX is constantly growing and more features are added constantly. You can see our full API documentation in the following link.

https://documenter.getpostman.com/view/5481262/2s935hQmgP To create your API Key to use with third-party applications, go to Admin > Admin > Application Keys.

Here, you just need to enter a description to identify the key and select which tenant you wish to have the API connection with. You can choose a specific tenant, or select Any Tenant to be able to get API calls from any tenant.

You can enable or disable the API Key at any moment. Once done, click on Save. This will generate the API Key. If you go back to the Key you created, in the list button in the upper right-hand corner, you will see the API key you can copy and use with your third-party application.

]]>
https://wiki.vitalpbx.org/wiki/api-and-ami/api/feed/ 0