You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+63-40Lines changed: 63 additions & 40 deletions
Original file line number
Diff line number
Diff line change
@@ -1,30 +1,40 @@
1
1
# PhreakScript
2
-
A utility to automate the installation, maintenance, and debugging of Asterisk/DAHDI, while integrating additional patches to provide the richest telephony experience.
2
+
3
+
**A utility to automate the installation, maintenance, and debugging of Asterisk/DAHDI, while integrating additional patches to provide the richest telephony experience.**
3
4
4
5
PhreakScript installs:
5
6
6
-
- Asterisk 21.4.3 (latest standard release[1] of Asterisk)
7
+
- Asterisk 22.0.0 (latest LTS release[1] of Asterisk)
7
8
- DAHDI Linux 3.4.0 (with optional DAHDI install flag)
[1] Normally, PhreakScript installs the latest LTS version of Asterisk. However, version 21 will be installed by default until version 22 is released,
118
-
due to the significant change in functionality from version 20 which allows for a richer installation by default.
119
-
To install the latest LTS version (20), you can specify the version explicitly e.g. `--version=20.5.0`.
120
-
However, there should not be a need to do so unless you are using obsolete modules that were removed in Asterisk 21.
121
+
> [!NOTE]
122
+
> [1] Currently, PhreakScript installs the latest LTS version of Asterisk. However,
123
+
when a standard release is the most recent release, it may be installed by default.
124
+
To install a specific major version, you can specify it explicitly e.g. `--version=22`.
121
125
122
-
### Installation
126
+
> [!NOTE]
127
+
> PhreakScript is primarily an automation tool, but it also adds a significant amount of functionality to Asterisk beyond what is available upstream, making it a superset of "vanilla Asterisk". We aim to upstream our patches whenever practical; in fact, we are among the most active and frequent contributors to the Asterisk and DAHDI projects. This repository includes enhancements that are not available upstream as well as those that may be in the future but are not currently. A list of upstreamed Asterisk patches can be found at https://phreaknet.org/changes
123
128
124
-
Please refer to the Docs: https://docs.phreaknet.org/#phreakscript
Then, you can use PhreakScript. Run ```phreaknet help``` or ```phreaknet examples``` to get started.
137
145
138
-
For a basic install, you can run `phreaknet install`
146
+
For a basic install, you can run `phreaknet install`. This installs all the pre-requisites for Asterisk and then downloads and builds Asterisk, completely non-interactively.
139
147
140
148
To install with DAHDI, run `phreaknet install --dahdi` (add `--drivers` to also restore drivers that were removed upstream in DAHDI 3).
141
149
142
-
For a guided, interactive installation, you can also run `phreaknet wizard`. The wizard will determine what installation options are best for you, based on your preferences.
150
+
For a guided, interactive installation, you can also run `phreaknet wizard`. The wizard will determine what installation options are best for you, based on your preferences. However, the wizard tool is not comprehensive for all available options.
151
+
152
+
For further details, please refer to the Docs: https://docs.phreaknet.org/#phreakscript
143
153
144
-
PhreakScript must be run as root, even if Asterisk will not be installed to run as root.
154
+
> [!TIP]
155
+
> There are a plethora of flags available that modify the installation process in various ways. It is highly recommended that you run ```phreaknet help``` and spend some time reading through the available options to craft the installation command that is appropriate for your system. Flags are available for most commonly used installation scenarios.
145
156
146
-
PhreakScript is primarily supported on Debian-based Linux systems, and DAHDI and Asterisk are best supported on these platforms.
147
-
Limited support is available for other Linux distros (Fedora, RHEL, Rocky Linux, SUSE, Arch Linux, etc.).
148
-
Extremely limited support exists for FreeBSD, and BSDs (and UNIX in general) are not recommended for running Asterisk/DAHDI - use Linux instead if possible.
157
+
> [!IMPORTANT]
158
+
> PhreakScript must be run as root, even if Asterisk will not be installed to run as root.
159
+
160
+
> [!CAUTION]
161
+
> PhreakScript is primarily supported on Debian-based Linux systems, and DAHDI and Asterisk are best supported on these platforms.
162
+
> Limited support is available for other Linux distros (Fedora, RHEL, Rocky Linux, SUSE, Arch Linux, etc.).
163
+
> Extremely limited support exists for FreeBSD, and BSDs (and UNIX in general) are not recommended for running Asterisk/DAHDI - use Linux instead if possible.
149
164
150
165
### License
151
166
152
167
PhreakScript itself is licensed under the Apache 2.0 License. This includes any scripts in this repository.
153
168
154
169
However, any Asterisk modules ("C" code) in this repository (such as those that may be installed by PhreakScript) are licensed under the GNU General Public License Version 2 (GPLv2), per the Asterisk licensing terms.
155
170
156
-
If you have copyright or licensing doubts, please refer to any copyrights and licensing terms in individual source files.
171
+
> [!TIP]
172
+
> If you have copyright or licensing doubts, please refer to any copyrights and licensing terms in individual source files.
157
173
158
174
### Documentation
159
175
@@ -163,11 +179,18 @@ Please refer to the PhreakNet Asterisk documentation for PhreakScript-specific m
163
179
164
180
Please run ```phreaknet about```
165
181
182
+
> [!NOTE]
183
+
> Note that the change log is no longer updated for every change. For a complete history, please refer to the commit history.
184
+
166
185
### Reporting Issues
167
186
168
-
The preferred issue reporting procedure is by cutting us a ticket at InterLinked Issues: https://issues.interlinked.us/
187
+
To report an issue, you may do one of the following:
188
+
189
+
- (Preferred) Cut us a ticket at InterLinked Issues: https://issues.interlinked.us/
190
+
191
+
Choose "PhreakScript" as the category, *not* Asterisk, DAHDI, or anything else!
FILE_NAME=$( basename $0)# grr... why is realpath not in the POSIX standard?
@@ -2719,7 +2718,7 @@ get_source() {
2719
2718
fi
2720
2719
if [ "$CHAN_SIP"="1" ];then# somebody still wants chan_sip, okay...
2721
2720
if [ "$ENHANCED_CHAN_SIP"!="1" ];then
2722
-
echoerr "chan_sip is deprecated and will be removed in Asterisk 21. Consider migrating to chan_pjsip at your convenience."
2721
+
echoerr "chan_sip is deprecated and was removed in Asterisk 21. Consider migrating to chan_pjsip at your convenience."
2723
2722
else
2724
2723
echoerr "chan_sip was deprecated and removed in Asterisk 21. It is still present for your usage, but consider migrating to chan_pjsip at your convenience."
2725
2724
printf"Fetching chan_sip to readd to source tree\n"
0 commit comments