mirror of
https://github.com/chuot/rdio-scanner.git
synced 2026-08-13 08:33:00 -06:00
88 lines
5.5 KiB
Markdown
88 lines
5.5 KiB
Markdown
|
|
|
|
## What is it ?
|
|
|
|
[Rdio Scanner](https://github.com/chuot/rdio-scanner) is an open source software that ingest and distribute audio files generated by various software-defined radio recorders. Its interface tries to reproduce the user experience of a real police scanner, while adding its own touch.
|
|
|
|
You can listen to [Rdio Scanner](https://github.com/chuot/rdio-scanner) on any modern browsers using the integrated web app.
|
|
|
|
## Recorders compatibility
|
|
|
|
[Rdio Scanner](https://github.com/chuot/rdio-scanner) works with any radio recorder, as long as they can create audio files separated by conversations or transmissions.
|
|
|
|
Here is a list of recorders known to work with [Rdio Scanner](https://github.com/chuot/rdio-scanner):
|
|
|
|
| Recorder | API | Dirwatch |
|
|
| -------------------------------------------------------------- | --- | -------- |
|
|
| [Trunk Recorder](https://github.com/robotastic/trunk-recorder) | X | X |
|
|
| [RTLSDR-Airband](https://github.com/szpajder/RTLSDR-Airband) | | X |
|
|
| [SDRTrunk](https://github.com/DSheirer/sdrtrunk) | X | |
|
|
| [voxcall](https://github.com/aaknitt/voxcall) | X | |
|
|
| [ProScan](https://www.proscan.org/) | | X |
|
|
| [DSDPlus Fast Lane](https://https://www.dsdplus.com/) | | X |
|
|
|
|
## Quick start
|
|
|
|
ALWAYS DOWNLOAD THE LATEST VERSION OF [RDIO SCANNER](https://github.com/chuot/rdio-scanner) FROM ITS OFFICIAL REPOSITORY AT **[HTTPS://GITHUB.COM/CHUOT/RDIO-SCANNER](https://github.com/chuot/rdio-scanner)**.
|
|
|
|
1. Download the latest precompiled version of [Rdio Scanner](https://github.com/chuot/rdio-scanner) from the [releases tab](https://github.com/chuot/rdio-scanner/releases).
|
|
|
|
| Operating system | Architecture | Use package |
|
|
| -----------------| ------------ | ------------------------------------- |
|
|
| FreeBSD | amd64 | rdio-scanner-freebsd-amd64-v7.0.0.zip |
|
|
| Linux | 386 | rdio-scanner-linux-386-v7.0.0.zip |
|
|
| Linux | amd64 | rdio-scanner-linux-amd64-v7.0.0.zip |
|
|
| Linux | arm | rdio-scanner-linux-arm-v7.0.0.zip |
|
|
| Linux | arm64 | rdio-scanner-linux-arm64-v7.0.0.zip |
|
|
| macOS | amd64 | rdio-scanner-macos-amd64-v7.0.0.zip |
|
|
| macOS | arm64 | rdio-scanner-macos-arm64-v7.0.0.zip |
|
|
| Windows | amd64 | rdio-scanner-macos-amd64-v7.0.0.zip |
|
|
|
|
2. Extract the contents of the archive somewhere on your computer.
|
|
3. Run the [Rdio Scanner](https://github.com/chuot/rdio-scanner) executable.
|
|
4. Access the administrative dashboard to finalize the configuration.
|
|
|
|
More detailed instructions are available in the `rdio-scanner.pdf` file provided in the precompiled archives.
|
|
|
|
## Docker
|
|
|
|
As a courtesy to Docker users, [Rdio Scanner](https://github.com/chuot/rdio-scanner) is also distributed as a Docker image where a new version is generated with each new release. More information available at **[https://hub.docker.com/repository/docker/chuot/rdio-scanner](https://hub.docker.com/repository/docker/chuot/rdio-scanner)**.
|
|
|
|
## Need help ?
|
|
|
|
### GitHub Wiki
|
|
|
|
Your question might already be addressed on the [Rdio Scanner GitHub Wiki](https://github.com/chuot/rdio-scanner/wiki), be sure to check it out at **[https://github.com/chuot/rdio-scanner/wiki](https://github.com/chuot/rdio-scanner/wiki)**.
|
|
|
|
### GitHub Discussions
|
|
|
|
Feel free to ask your questions or share your comments on the [Rdio Scanner GitHub discussions](https://github.com/chuot/rdio-scanner/discussions) at **[https://github.com/chuot/rdio-scanner/discussions](https://github.com/chuot/rdio-scanner/discussions)**.
|
|
|
|
## Show your appreciation, support the author
|
|
|
|
If you like [Rdio Scanner](https://github.com/chuot/rdio-scanner), **[consider starring the GitHub repository](https://github.com/chuot/rdio-scanner/stargazers)** to show you appreciation to the author for his hard work. It cost nothing but is really appreciated.
|
|
|
|
If you use [Rdio Scanner](https://github.com/chuot/rdio-scanner) for commercial purposes or derive income from it, **[sponsor the project](https://github.com/sponsors/chuot)** to help support continued development.
|
|
|
|
## Improve your experience on the go
|
|
|
|
You can enjoy your [Rdio Scanner](https://github.com/chuot/rdio-scanner) on the go on your mobile device with the native app.
|
|
|
|
[](https://apps.apple.com/us/app/rdio-scanner/id1563065667#?platform=iphone)
|
|
[](https://play.google.com/store/apps/details?id=solutions.saubeo.rdioScanner)
|
|
|
|
## Contributing
|
|
|
|
By submitting a contribution to this repository, you agree to the terms of the [Individual Contributor Assignment Agreement](./ICAA.md).
|
|
|
|
## WebSocket API - Commercial Use
|
|
|
|
This project is licensed under the GNU GPL. The **HTTP REST API** is fully available for all uses.
|
|
|
|
However, the **WebSocket API** is a proprietary service provided exclusively by Saubeo Solutions for its native applications and the integrated web application. This restriction supports the commercial model that funds this project's development.
|
|
|
|
Self-hosted deployments can use the HTTP REST API without limitation. Access to the WebSocket API in self-hosted instances requires a license agreement. For details, see [API_ACCESS_POLICY.md](API_ACCESS_POLICY.md).
|
|
|
|
---
|
|
|
|
**Happy Rdio scanning !** |