fwconsole

Manage FreePBX from the command line

TLDR

Reload FreePBX configurations

$ fwconsole reload

Start Asterisk and other commands needed by FreePBX

$ fwconsole start

Stop Asterisk and other commands needed by FreePBX

$ fwconsole stop

View and update settings

$ fwconsole setting [keyword] [new_value]

List available backups

$ fwconsole backup --list

List available FreePBX commands

$ fwconsole list

Change ownership of all files and directories that FreePBX needs to be owned by the apache user

$ fwconsole chown

--help
    Display help information about fwconsole or a specific command.

--version
    Display the fwconsole version.

--verbose
    Enable verbose output.

--quiet
    Suppress output messages.

--no-ansi
    Disable ANSI output.

--module=
    Specify a module to run a command against. (Useful for module specific commands)

--display-errors
    Display PHP errors.

--force
    Force execution of a command, bypassing certain checks or prompts.

DESCRIPTION

The `fwconsole` command provides a comprehensive command-line interface for managing FreePBX, a web-based open-source GUI that manages Asterisk. It allows administrators to perform various tasks such as installing and updating modules, configuring system settings, managing users and extensions, troubleshooting issues, and performing maintenance operations without needing to use the FreePBX web interface. The `fwconsole` utility is a crucial tool for automating FreePBX administration, especially in scripted environments or when access to the web interface is restricted. It offers a direct way to interact with the FreePBX system, enabling efficient and precise control over its functionalities.
Using fwconsole is important since it provides the ability to execute module commands that extend features that are not easily available through the GUI.
It is a powerful and versatile tool for FreePBX administrators.

CAVEATS

Using `fwconsole` requires appropriate permissions. It's typically run as the `asterisk` user or with `sudo`. Incorrect usage can lead to system instability or data corruption.

COMMON COMMANDS

Some frequently used `fwconsole` commands include `ma listonline` (to list available modules), `ma install ` (to install a module), `ma upgrade ` (to upgrade a module), `reload` (to reload Asterisk configuration), and `restart` (to restart Asterisk).

MODULE MANAGEMENT

`fwconsole ma` is the primary command for module management. It allows you to install, uninstall, enable, disable, upgrade, and list modules.

CACHE MANAGEMENT

`fwconsole cache` has commands for managing the cache stored. Such as `fwconsole cache clear` to clear the cache stored.

HISTORY

The `fwconsole` command evolved alongside FreePBX. Originally, FreePBX administration was often done through direct manipulation of Asterisk configuration files. As FreePBX matured, `fwconsole` was developed to provide a more structured and reliable interface for managing the system.
It has undergone several revisions as FreePBX has added features. Its adoption has streamlined administration tasks and reduced the risk of manual configuration errors.