Archive/rdio-scanner
1
0
Fork 0
mirror of https://github.com/chuot/rdio-scanner.git synced 2026-08-13 16:33:01 -06:00
Code Issues Actions Packages Projects Releases Wiki Activity
rdio-scanner/docs/platforms/darwin.md
Chrystian Huot ef549189b4 Version 6.2.3
2022-03-30 14:00:17 -04:00

221 lines
10 KiB
Markdown
Raw Blame History

![Rdio Scanner](../images/rdio-scanner.png?raw=true)\
\pagebreak{}
# 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 |
# 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.
[![Available on the App Store](../images/app-store-badge.png?raw=true)](https://apps.apple.com/us/app/rdio-scanner/id1563065667#?platform=iphone)
[![Get it on Google Play](../images/google-play-badge.png?raw=true)](https://play.google.com/store/apps/details?id=solutions.saubeo.rdioScanner)
\pagebreak{}
# 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)**. PRECOMPILED VERSIONS ARE LOCATED UNDER THE [RELEASES TAB](https://github.com/chuot/rdio-scanner/releases).
1. Make sure you have the latest version of [Rdio Scanner](https://github.com/chuot/rdio-scanner).
2. Extract the contents of the archive somewhere on your computer. The configuration file and the database file will be created in this same folder.
rdio@macos ~ % mkdir rdio-scanner
rdio@macos ~ % cd rdio-scanner
rdio@macos rdio-scanner % unzip \
> ~/Downloads/rdio-scanner-darwin-arm64-v6.2.3.zip
Archive: /Users/rdio/Downloads/rdio-scanner-darwin-arm64-v6.2.3.zip
inflating: rdio-scanner
inflating: rdio-scanner.pdf
3. Run the executable.
rdio@macos rdio-scanner % ./rdio-scanner
Rdio Scanner v6.2.3
----------------------------------
2022/03/30 08:38:06 server started
2022/03/30 08:38:06 main interface at http://macos.local:3000
2022/03/30 08:38:06 admin interface at http://macos.local:3000/admin
4. Access the administrative dashboard to finalize the configuration.
> _Note that the default password is **rdio-scanner**_
![admin dashboard login](../images/admin-login.png?raw=true)\
5. Configure your [Rdio Scanner](https://github.com/chuot/rdio-scanner) instance.
![admin dashboard todos](../images/admin-todos.png?raw=true)\
\pagebreak{}
# Advanced customizations
## Listening on an alternate port
Here we want our [Rdio Scanner](https://guthub.com/chuot/rdio-scanner) instance to listen for connections on the standard HTTP port.
rdio@macos rdio-scanner % ./rdio-scanner --listen :80
Rdio Scanner v6.2.3
----------------------------------
2022/03/30 08:48:03 server started
2022/03/30 08:48:03 main interface at http://macos.local
2022/03/30 08:48:03 admin interface at http://macos.local/admin
## Listening on a SSL port
It is recommended to share your [Rdio Scanner](https://github.com/chuot/rdio-scanner) instance over the internet by listening to an SSL port.
You can use your own SSL certificates that match your domain name with `-ssl_cert_file` and `-ssl_key_file`. If your certificate comes with an intermediate CA certificate, simply add its contents to the standard certificate file.
rdio@macos rdio-scanner % ./rdio-scanner \
> -listen :80 \
> -ssl_cert_file mycert.crt \
> -ssl_key_file mykey.key \
> -ssl_listen :443
Rdio Scanner v6.2.3
----------------------------------
2022/03/30 08:50:58 server started
2022/03/30 08:50:58 main interface at http://macos.local
2022/03/30 08:50:58 main interface at https://macos.local
2022/03/30 08:50:58 admin interface at https://macos.local/admin
If you don't want to worry about SSL certificates, you can use the built-in Let's Encrypt auto-cert feature. This requires that you have both port 80 (HTTP) and port 443 (HTTPS) open to the world. Also, your domain name should point to your IP address where [Rdio Scanner](https://github.com/chuot/rdio-scanner/) is running. The advantage of this approach is that everything is done automatically, no certificate request, no certificate renewal.
rdio@macos rdio-scanner % ./rdio-scanner \
> -listen :80 \
> -ssl_auto_cert mydomain.com \
> -ssl_listen :443
## Save your advanced configuration to a config file
You don't want to have to type everytime a long list of arguments. No problem, you can save your advanced configuration to a file by adding the **-config_save** argument.
rdio@macos rdio-scanner % ./rdio-scanner \
> -listen :80 \
> -ssl_auto_cert mydomain.com \
> -ssl_listen :443 \
> -config_save
2022/03/30 08:52:24 rdio-scanner.ini file created
All of your parameters passed as arguments to [Rdio Scanner](https://github.com/chuot/rdio-scanner) have been saved to an INI file which has the same arguments/values list.
db_file = rdio-scanner.db
db_type = sqlite
listen = :80
ssl_auto_cert = mydomain.com
ssl_listen = :443
Then simply run [Rdio Scanner](https://github.com/chuot/rdio-scanner) without any arguments.
rdio@macos rdio-scanner % ./rdio-scanner
Rdio Scanner v6.2.3
----------------------------------
2022/03/30 08:54:08 server started
2022/03/30 08:54:08 main interface at http://macos.local
2022/03/30 08:54:08 main interface at https://macos.local
2022/03/30 08:54:08 admin interface at https://macos.local/admin
## Install Rdio Scanner as a service
Everything looks ok now, but you do not want to manualy start [Rdio Scanner](https://github.com/chuot/rdio-scanner) after every reboot. No problem, you can install your server instance as a service. **Note that you will be required to proceed in a command prompt that is running as Administrator**.
rdio@macos rdio-scanner % sudo ./rdio-scanner -service install
Password:
rdio@macos rdio-scanner % sudo ./rdio-scanner -service start
rdio@macos rdio-scanner % ps ax | grep rdio-scanner
64627 ?? Ss 0:00.13 /Users/chuot/rdio-scanner/rdio-scanner -service run
64630 s000 S+ 0:00.00 grep rdio-scanner
\pagebreak{}
## Get the full list of arguments
To get the whole list of arguments you can pass to [Rdio Scanner](https://github.com/chuot/rdio-scanner), simply pass the argument **-h**.
rdio@macos rdio-scanner % ./rdio-scanner -h
Usage of ./rdio-scanner:
-admin_password string
change admin password
-base_dir string
base directory where all data will be written
-config string
server config file (default "rdio-scanner.ini")
-config_save
save configuration to rdio-scanner.ini
-db_file string
sqlite database file (default "rdio-scanner.db")
-db_host string
database host ip or hostname (default "localhost")
-db_name string
database name
-db_pass string
database password
-db_port uint
database host port (default 3306)
-db_type string
database type, one of sqlite, mariadb, mysql (default "sqlite")
-db_user string
database user name
-listen string
listening address (default ":3000")
-service string
service command, one of start, stop, restart, install, uninstall
-ssl_auto_cert string
domain name for Let's Encrypt automatic certificate
-ssl_cert_file string
ssl PEM formated certificate
-ssl_create
create self-signed certificates
-ssl_key_file string
ssl PEM formated key
-ssl_listen string
listening address for ssl
-version
show application version
rdio@macos rdio-scanner %
\pagebreak{}
# Need help ?
You can ask your questions or post your comments on the [Rdio Scanner 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.
[![Follow us on Twitter](../images/twitter-badge.png?raw=true)](https://twitter.com/RdioScanner)
# Commercial support
Commercial support is available at **[https://saubeo.solutions/](https://saubeo.solutions)**.
**Happy Rdio scanning !**
\pagebreak{}
Reference in a new issue View git blame Copy permalink