Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
msmhome authored Aug 4, 2024
1 parent 1f21e68 commit aa8e3f3
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<img align="right" width="400" height="400" src="https://i.imgur.com/pCU81k6.png">

A tiny, ready to deploy, simple fax and SMS recieve server running on the Telynx Programmable Fax and SMS APIs.
A tiny, ready to deploy, simple fax and SMS receive server running on the Telynx Programmable Fax and SMS APIs.

This is built around my use case and homelab but is versatile to be deployed as-is for yours or be used in something more complex.
* **Fax Inbound and Outbound w/ Confirmations**
Expand All @@ -17,23 +17,23 @@ This has not been tested at scale and outside of my personal at-home use, while

# Usage

It's useful to deploy this in a container on a NAS and use a network file share, or run on docker desktop with host path directories mounted.
It's useful to deploy this in a container on a NAS and use a network file share or run locally on Docker with host path directories mounted.

miniFaxServer revolves around the /Faxes directory. Faxes and SMS messages recieved are dumped there in encoded .pdf or .txt files respectively. 
miniFaxServer revolves around the /Faxes directory. Faxes and SMS messages received are dumped there in encoded .pdf or .txt files, respectively. 

Add your own IP ranges in the .env whitelist, the default entries are for Telnyx's servers and should not be changed. Try host 0.0.0.0 if you encounter problems with whitelist.
Add your own IP ranges to the .env whitelist. The default entries are for Telnyx's servers and should not be changed. Try host 0.0.0.0 if you encounter problems with whitelist.

#### Fax In

Faxes recieved will be saved as a PDF in the Faxes directory with the name `from_+12015550000_telnyx-delivery-webhook-id.pdf`.
The faxes received will be saved as a PDF in the Faxes directory under the name `from_+12015550000_telnyx-delivery-webhook-id.pdf`.

It is recommended to enable the feature to email faxes in the telnyx web gui (it's free).
It's recommended to enable the feature to email faxes in the Telnyx web GUI (it's free).

#### Fax Out

Put any PDF files to be sent out in the Faxes/outbound directory named as the destination phone number excluding the country code. ie `8885550000.pdf`. This will begin an automatic process to fax that PDF, once delivered, the PDF will be moved to Faxes/outbound\_confirmations as `+18885550000_telnyx-delivery-webhook-id_confirmed.pdf`.
Put any PDF files to be sent out in the Faxes/outbound directory named as the destination phone number, excluding the country code. ie `8885550000.pdf`. This will begin an automatic process to fax that PDF, once delivered, the PDF will be moved to Faxes/outbound\_confirmations as `+18885550000_telnyx-delivery-webhook-id_confirmed.pdf`.

(note for my use I hard coded the US +1 country code, modify or remove this in the script as necessary)
(note for my use I hardcoded the US +1 country code, modify or remove this in the script as necessary)

#### SMS In

Expand All @@ -55,17 +55,17 @@ Pull the prebuilt container image, or just specify `ghcr.io/msmhome/minifaxserve
* `/app/Faxes/outbound/`
* `/app/Faxes/outbound_confirmations/`

Also set the `TUNNEL_TOKEN` environment variable for the container with your Cloudflare Tunnel token.  
Also, set the `TUNNEL_TOKEN` environment variable for the container with your Cloudflare Tunnel token.  

### Cloudflare Tunnels (cloudflared)

Cloudflared is built in and recommended instead of an open port. Enable `Disable Chunked Encoding`

It's also recommended to get an origin server certificate, save the certificate and private key to `Faxes/certs/certificate.pem` and `Faxes/certs/key.pem` respectively. Make sure to set your cloudflare tunnel configuration as HTTPS and set the origin server name.  
It's also recommended to get an origin server certificate and save the certificate and private key to `Faxes/certs/certificate.pem` and `Faxes/certs/key.pem`, respectively. Make sure to set your cloudflare tunnel configuration as HTTPS and set the origin server name.  

## Resources

#### Need to test your fax set up?
#### Need to test your fax setup?

Try the [Canon](https://community.usa.canon.com/t5/Desktop-Inkjet-Printers/G7020-FAX/m-p/295192/highlight/true#M17767) Test Fax Service at +1 855-392-2666. This has better uptime than HP's fax test service, and replies faster.

Expand Down

0 comments on commit aa8e3f3

Please sign in to comment.