Merge remote-tracking branch 'moke/main'

README.md

@@ -4,7 +4,10 @@ Linux Fax Stack using Hylafax and t38modem.
 
 ***THIS GUIDE IS WIP***
 
-This guide was created using information from the opalvoip wiki (http://wiki.opalvoip.org/index.php?n=Main.HomePage)
+This guide was created using information from the opalvoid wiki (http://wiki.opalvoip.org/index.php?n=Main.HomePage).
+Please do not follow this guide blindly.
+Some used Opal versions are marked as being infected with malware by SourceForge.
+**We are strongly discouraging, that you are using these versions.**
 
 ## Software stack
 
@@ -12,7 +15,7 @@ This guide was created using information from the opalvoip wiki (http://wiki.opa
 (legacy) library for doing a little bit of everything.
 
 ### Opal
-Voice codec used by e.g. mumble.
+Voice codec
 
 ### t38modem
 Emulates a serial modem from SIP connection
@@ -29,6 +32,8 @@ Unfortunately this software stack uses a lot of legacy software. Because of this
 For Debian 12, we'll only install dependencies which are hard requirements.
 For this guide we'll use ptlib 2.18.6 and opal 3.18.6.
 
+WARNING: Hylafax will get stuck during the modem probing process.
+
 #### Installing Requirements
 First we'll need some packages
 ```bash
@@ -38,7 +43,7 @@ apt-get install build-essential git wget pkg-config libssl-dev libsrtp2-dev libs
 Versions:
 - libpt (2.18.6) https://sourceforge.net/projects/opalvoip/files/v3.18 Cygni/Stable 6/
 - opal (3.18.6) https://sourceforge.net/projects/opalvoip/files/v3.18 Cygni/Stable 6/
-- t38mdem (4.6.2) https://github.com/hehol/t38modem/releases/tag/4.6.2
+- t38modem (4.6.2) https://github.com/hehol/t38modem/releases/tag/4.6.2
 
 #### ptlib
 ```bash
@@ -50,7 +55,7 @@ make install
 #### opal
 ```bash
 ./configure
-make -j5
+make
 make runtest
 make install
 ```
@@ -165,7 +170,7 @@ sudo cp ./t38modem /usr/local/bin
 ## Configuring t38modem
 ### Init script
 
-- To automatically start t38modem, you need to create Systemd services, as well as start and stop scripts
+- To automatically start t38modem, you need to create Systemd services
 - script is adapted from https://web.archive.org/web/20111231021042/https://www.foriamroot.org/hylafax-6-0-debian-or-ubuntu-t38modem-1-0-asterisk-1-6/
 
 First we'll create the configuration directory under `/etc` using `sudo mkdir -p /etc/t38modem/bin/`.
@@ -211,9 +216,9 @@ sudo chmod +x /etc/t38modem/bin/run
 
 ### Create the configuration file
 Create a file using the following contents at `/etc/t38modem/config/XX`.
+Replace `XX` with the modem number.
 
 ```bash
-# /etc/t38modem/config
 T38MODEM_PTTY_ID="XX" # /dev/ttyT38-XX
 T38MODEM_SIP_USERNAME="USERNAME"
 T38MODEM_SIP_PASSWORD="PASSWORD"
@@ -242,6 +247,7 @@ sudo chmod 700 -R /etc/t38modem/config/
     - -> `RING`
     - Answer the call: `ata` -> `CONNECT`
     - You should now hear your modem "talking" to you
+    - ATH means hang up
 - Pitfalls:
   - If you are already connected to your SIP server it may not give proper response codes. My provider returns `500 Internal Server Error`
   - Test the command before running the init script!
@@ -327,6 +333,14 @@ CountryCode:	1
 AreaCode:		999
 ```
 
+## Apply configuration
+If HylaFax doesn't receive or send faxes, you can try restarting it.
+This can be done using
+```bash
+sudo /etc/init.d/hylafax stop
+sudo /etc/init.d/hylafax start
+```
+
 ## FaxDispatch
 
 - https://legacy.hylafax.org/content/Advanced_Permissions_with_6.0