phreaknet.1

.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "PHREAKNET" "1" "August 2022" "PhreakScript 0.1.83" ""
.hy
.SH NAME
.PP
phreaknet - install, enhance, configure, and manage Asterisk and DAHDI
.SH SYNOPSIS
.PP
\f[B]phreaknet\f[R] \f[I]command\f[R] [\f[I]OPTION\f[R]]
.SH DESCRIPTION
.PP
\f[B]phreaknet\f[R] automates the installation, maintenance, and
debugging of Asterisk and DAHDI while integrating additional patches to
provide the richest telephony experience.
The utility automatically installs any necessary prerequisites as part
of operation.
.PP
It also contains tools to automate the process of setting up a new node
on PhreakNet (hence the utility\[aq]s name).
However, it can be used to set up any generic Asterisk system.
.PP
PhreakScript installs the latest LTS (Long Term Servicing) version of
Asterisk along with the latest releases of DAHDI Linux and DAHDI Tools
(if the -d or --dahdi options are specified).
Many additional bug fixes, features, enhancements, and improvements are
also provided to provide the best Asterisk and DAHDI experience.
.SH COMMANDS
.SS Getting started
.TP
\f[B]about\f[R]
Provides information about PhreakScript
.TP
\f[B]help\f[R]
Provides a condensed command and option listing
.TP
\f[B]version\f[R]
Print current PhreakScript version and exit
.TP
\f[B]examples\f[R]
Print some examples of PhreakScript usage
.TP
\f[B]info\f[R]
Print current system, Asterisk, and DAHDI version information and exit
.TP
\f[B]wizard\f[R]
Interactive installation wizard for most common install options
.SS First Use and Installation
.TP
\f[B]make\f[R]
Add PhreakScript to path
.TP
\f[B]man\f[R]
Compile and install PhreakScript man page
.TP
\f[B]mancached\f[R]
Install cached PhreakScript man page (may be outdated)
.TP
\f[B]install\f[R]
Install or upgrade Asterisk.
This is the primary command provided by PhreakScript.
.TP
\f[B]dahdi\f[R]
Install or upgrade DAHDI (only).
Generally this command does not need to be used.
To install Asterisk with DAHDI, use the install command and provide the
-d or --dahdi option instead.
.TP
\f[B]odbc\f[R]
Install ODBC (Open Database Connector) for MariaDB
.TP
\f[B]installts\f[R]
Install Asterisk Test Suite
.TP
\f[B]fail2ban\f[R]
Install Asterisk fail2ban configuration
.TP
\f[B]apiban\f[R]
Install apiban client
.TP
\f[B]freepbx\f[R]
Install FreePBX GUI (not recommended).
This is used to install the FreePBX GUI on an existing Asterisk
installation.
To install Asterisk with FreePBX, provide the --freepbx flag to the
install command instead.
.TP
\f[B]pulsar\f[R]
Install Revertive Pulsing simulator (audio files and AGI script).
.TP
\f[B]sounds\f[R]
Install Pat Fleet sound library, overwriting any default Asterisk
prompts that they may replace.
.TP
\f[B]boilerplate-sounds\f[R]
Install PhreakNet boilerplate audio sounds.
.TP
\f[B]ulaw\f[R]
Convert a wav file to ulaw.
If no argument is provided, all wav files in the current directory will
be converted.
If an argument is provided, only the specified file will be converted.
.TP
\f[B]uninstall\f[R]
Uninstall Asterisk, but leave configuration behind
.TP
\f[B]uninstall-all\f[R]
Uninstall Asterisk, and completely remove all traces of it (configs,
etc.)
.SS Initial Configuration
.TP
\f[B]bconfig\f[R]
Install PhreakNet boilerplate config
.TP
\f[B]config\f[R]
Install PhreakNet boilerplate config and autoconfigure PhreakNet
variables in the [globals] context in your dialplan
.TP
\f[B]keygen\f[R]
Install and update PhreakNet RSA keys.
If you are installing keys for the first time, you should specify the
--rotate flag.
.SS Maintenace
.TP
\f[B]update\f[R]
Update PhreakScript to the latest version.
You should run this regularly, and before using this utility for
installations.
If PhreakScript is out of date, a warning will be displayed before a
requested operation is performed.
.TP
\f[B]patch\f[R]
DEPRECATED.
Patch PhreakNet Asterisk configuration.
.TP
\f[B]genpatch\f[R]
DEPRECATED.
Generate a PhreakPatch (patch to be used with the phreaknet patch
command)
.TP
\f[B]freedisk\f[R]
Free up disk space, useful if disk space is running low.
This command will rotate and remove old logs, remove unused swap files,
remove old package files, and remove core dump files.
.TP
\f[B]topdisk\f[R]
Show top files taking up disk space
.TP
\f[B]enable-swap\f[R]
Temporarily allocate and enable swap file
.TP
\f[B]disable-swap\f[R]
Disable and deallocate temporary swap file
.TP
\f[B]restart\f[R]
Fully restart DAHDI and Asterisk
.TP
\f[B]kill\f[R]
Forcibly kill Asterisk
.TP
\f[B]forcerestart\f[R]
Forcibly restart Asterisk
.TP
\f[B]ban\f[R]
Manually ban an IP address using iptables.
Argument is the IP address to block.
.SS Debugging
.TP
\f[B]dialplanfiles\f[R]
Verify what files are being parsed into the dialplan
.TP
\f[B]validate\f[R]
DEPRECATED.
Run dialplan validation and diagnostics and look for problems
.TP
\f[B]trace\f[R]
Capture a CLI trace and upload to InterLinked Paste
.TP
\f[B]paste\f[R]
Upload an arbitrary existing file to InterLinked Paste
.TP
\f[B]iaxping\f[R]
Check if a remote IAX2 listener is reachable
.TP
\f[B]pcap\f[R]
Perform a packet capture, optionally against a specific IP address
.TP
\f[B]pcaps\f[R]
Same as pcap, but open in sngrep afterwards
.TP
\f[B]sngrep\f[R]
Perform SIP message debugging using \f[B]sngrep\f[R]
.TP
\f[B]enable-backtraces\f[R]
Enables backtraces to be extracted from the core dumper (new or existing
installs).
This may require Asterisk to be recompiled.
.TP
\f[B]backtrace\f[R]
Use astcoredumper to obtain a backtrace from a core dump and upload to
InterLinked Paste
.TP
\f[B]backtrace-only\f[R]
Use astcoredumper to process a backtrace
.TP
\f[B]rundump\f[R]
Get a backtrace from the running Asterisk process
.SS Developer Debugging
.TP
\f[B]valgrind\f[R]
Run Asterisk under valgrind.
Asterisk must not be running prior to running this command.
Asterisk will be started in the foreground (using the -c console mode).
.TP
\f[B]cppcheck\f[R]
Run cppcheck on Asterisk for static code analysis
.SS Development and Testing
.TP
\f[B]docverify\f[R]
Show documentation validation errors and details
.TP
\f[B]runtests\f[R]
Run differential PhreakNet tests
.TP
\f[B]runtest\f[R]
Run a specific PhreakNet test.
The argument is the name of the specific test to run.
.TP
\f[B]stresstest\f[R]
Run any specified test multiple times in a row.
The argument is the name of the specific test to run.
.TP
\f[B]gerrit\f[R]
Manually install a custom patch set from the Asterisk Gerrit repository
.TP
\f[B]fullpatch\f[R]
Redownload an entire PhreakNet source file from the PhreakScript
repository.
.TP
\f[B]ccache\f[R]
Globally install ccache to speed up recompilation
.SS Miscellaneous
.TP
\f[B]docgen\f[R]
Generate Asterisk user documentation
.TP
\f[B]pubdocs\f[R]
DEPRECATED.
Generate Asterisk user documentation
.TP
\f[B]edit\f[R]
Edit local PhreakScript source directly
.SH OPTIONS
.TP
\f[B]-h\f[R]
Display usage
.TP
\f[B]-o\f[R], \f[B]--flag-test\f[R]
Option flag test.
This is a development option only used to verify proper option parsing
and handling.
.PP
Some options are only used with certain commands.
.PP
The following options may be used with the \f[B]install\f[R] command.
.TP
\f[B]--audit\f[R]
Audit package installation.
At the end of the install, a report will be generated showing what
packages were installed.
.TP
\f[B]-b\f[R], \f[B]--backtraces\f[R]
Enables getting backtraces
.TP
\f[B]-c\f[R], \f[B]--cc\f[R]
Country code used for Asterisk installation.
Default is 1 (NANPA).
.TP
\f[B]-d\f[R], \f[B]--dahdi\f[R]
Install DAHDI along with Asterisk.
.TP
\f[B]--drivers\f[R]
Also install DAHDI drivers removed in 2018 by Sangoma
.TP
\f[B]-f\f[R], \f[B]--force\f[R]
Force install a new version of DAHDI/Asterisk, even if one already
exists, overwriting old source directories if necessary.
.TP
\f[B]--freepbx\f[R]
Install FreePBX GUI (not recommended)
.TP
\f[B]--manselect\f[R]
Manually run menuselect yourself.
Generally, this is unnecessary.
.TP
\f[B]--minimal\f[R]
Do not upgrade the kernel or install nonrequired dependencies (such as
utilities that may be useful on typical Asterisk servers)
.TP
\f[B]-s\f[R], \f[B]--sip\f[R]
Install chan_sip instead of or in addition to chan_pjsip.
By default, chan_sip is not compiled or loaded since it is deprecated
and will be removed in Asterisk 21.
.TP
\f[B]--cisco\f[R]
Add full support for Cisco Call Manager phones using the usecallmanager
patches (chan_sip only)
.TP
\f[B]--sccp\f[R]
Install community chan_sccp channel driver (Cisco Skinny)
.TP
\f[B]-t\f[R], \f[B]--testsuite\f[R]
Compile with developer support for Asterisk test suite and unit tests.
.TP
\f[B]-u\f[R], \f[B]--user\f[R]
User as which to run Asterisk (non-root).
By default, Asterisk is install as root.
.TP
\f[B]--vanilla\f[R]
Do not install extra features or enhancements.
Bug fixes are always installed.
(May be required for older versions)
.TP
\f[B]-v\f[R], \f[B]--version\f[R]
Specific version of Asterisk to install (M.m.b e.g.
18.8.0).
Also, see \f[B]--vanilla\f[R].
.PP
The following options may be used with the \f[B]sounds\f[R] command.
.TP
\f[B]--boilerplate\f[R]
Also install boilerplate sounds
.PP
The following options may be used with the \f[B]config\f[R] command.
.TP
\f[B]--api-key\f[R]
InterLinked API key
.TP
\f[B]--clli\f[R]
CLLI code
.PP
The following options may be used with the \f[B]keygen\f[R] command.
.TP
\f[B]--rotate\f[R]
Rotate existing RSA keys or create keys if none exist.
.PP
The following options may be used with the \f[B]update\f[R] command.
.TP
\f[B]--upstream\f[R]
Specify upstream source from which to update PhreakScript.
By default, this is the official repository or development mirror.
.PP
The following options may be used with the \f[B]trace\f[R] command.
.TP
\f[B]--debug\f[R]
Debug level (default is 0/OFF, max is 10)
.SH EXAMPLES
.SS Installation and configuration examples
.TP
\f[B]phreaknet install\f[R]
Install the latest version of Asterisk.
.TP
\f[B]phreaknet install --cc=44\f[R]
Install the latest version of Asterisk, with country code 44.
.TP
\f[B]phreaknet install --force\f[R]
Reinstall the latest version of Asterisk.
.TP
\f[B]phreaknet install --dahdi\f[R]
Install the latest version of Asterisk, with DAHDI.
.TP
\f[B]phreaknet install --sip --weaktls\f[R]
Install Asterisk with chan_sip built AND support for TLS 1.0.
.TP
\f[B]phreaknet install --version 18.9.0\f[R]
Install Asterisk version 18.9.0 as the base version of Asterisk.
.TP
\f[B]phreaknet installts\f[R]
Install Asterisk Test Suite and Unit Test support (developers only)
.TP
\f[B]phreaknet pulsar\f[R]
Install revertive pulsing pulsar sounds and AGI, with bug fixes
.TP
\f[B]phreaknet sounds --boilerplate\f[R]
Install Pat Fleet sounds and basic boilerplate old city tone audio
.TP
\f[B]phreaknet config --force --api-key= --clli= --disa=\f[R]
Download and initialize boilerplate PhreakNet configuration
.TP
\f[B]phreaknet keygen\f[R]
Upload existing RSA public key to PhreakNet
.TP
\f[B]phreaknet keygen --rotate\f[R]
Create or rotate PhreakNet RSA keypair, then upload public key to
PhreakNet
.TP
\f[B]phreaknet validate\f[R]
Validate your dialplan configuration and check for errors
.SS Debugging examples
.TP
\f[B]phreaknet trace\f[R]
Perform a trace with verbosity 10 and no debug level (and notify the
Business Office)
.TP
\f[B]phreaknet trace --debug 1\f[R]
Perform a trace with verbosity 10 and debug level 1 (and notify the
Business Office)
.TP
\f[B]phreaknet backtrace\f[R]
Process, extract, and upload a core dump
.SS Maintenance examples
.TP
\f[B]phreaknet update\f[R]
Update PhreakScript.
No Asterisk or configuration modification will occur.
.TP
\f[B]phreaknet update --upstream=URL\f[R]
Update PhreakScript using URL as the upstream source (for testing).
.TP
\f[B]phreaknet patch\f[R]
Apply the latest PhreakNet configuration patches.
.TP
\f[B]phreaknet fullpatch app_verify\f[R]
Download the latest version of the app_verify module.
Recompilation will be required.
.SH EXIT VALUES
.TP
\f[B]0\f[R]
Success
.TP
\f[B]1\f[R]
Error
.TP
\f[B]2\f[R]
Error
.SH BUGS
.PP
Please report any bugs or issues at
https://github.com/InterLinked1/phreakscript
.PP
The public mailing list for discussion of this utility may be found at
https://groups.io/g/phreaknet
.SH COPYRIGHT
.PP
Copyright (C) 2022 PhreakNet, Naveen Albert and others.
.PP
Licensed under the Apache License, Version 2.0 (the \[dq]License\[dq]);
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
.PP
http://www.apache.org/licenses/LICENSE-2.0
.PP
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an \[dq]AS IS\[dq]
BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.
See the License for the specific language governing permissions and
limitations under the License.
.SH AUTHORS
Naveen Albert.