https://github.com/bjoernalbers/faxomat
A Fax Machine with HTTP API
https://github.com/bjoernalbers/faxomat
Last synced: 7 months ago
JSON representation
A Fax Machine with HTTP API
- Host: GitHub
- URL: https://github.com/bjoernalbers/faxomat
- Owner: bjoernalbers
- License: mit
- Created: 2015-01-07T09:30:23.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-07-05T11:15:19.000Z (almost 3 years ago)
- Last Synced: 2023-03-12T08:28:05.576Z (over 2 years ago)
- Language: Ruby
- Homepage:
- Size: 24.9 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Faxomat - Send faxes via HTTP
Faxomat provides a simple HTTP API for sending faxes like this:
```
/usr/bin/curl \
-F fax[phone]="0123456789" \
-F fax[title]="hello, world." \
-F fax[document]="@hello.pdf;type=application/pdf" \
http://localhost:3000/faxes
```
## Things you have to bring for production
You need the following:
- phone line and USB modem
- a hylafax server
- Docker for deployment of faxomat
## Quickstart (Development Environment)
- setup the the hylafax server and make sure it is working
- install docker
- clone this repo and run `docker compose up` to start the services
- then initialize the database in another terminal via `docker compose run bin/rake db:setup`
## License
Faxomat is released under the [MIT License](LICENSE.txt).