Skip to content
TNScanner edited this page Mar 12, 2025 · 1 revision

Quick start

ALWAYS DOWNLOAD THE LATEST VERSION OF RDIO SCANNER FROM ITS OFFICIAL REPOSITORY AT HTTPS://GITHUB.COM/CHUOT/RDIO-SCANNER. PRECOMPILED VERSIONS ARE LOCATED UNDER THE RELEASES TAB.

  1. Make sure you have the latest version of 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@pc-linux ~]$ mkdir rdio-scanner
     [rdio@pc-linux ~]$ cd rdio-scanner
     [rdio@pc-linux rdio-scanner]$ unzip \
     > ~/Downloads/rdio-scanner-linux-amd64-v6.6.3.zip 
     Archive:  /home/rdio/Downloads/rdio-scanner-linux-amd64-v6.6.3.zip
       inflating: rdio-scanner            
       inflating: rdio-scanner.pdf     
    
  3. Run the executable.

     [rdio@pc-linux rdio-scanner]$ ./rdio-scanner 
     
     Rdio Scanner v6.6.3
     ----------------------------------
     2022/11/25 09:11:48 server started
     2022/11/25 09:11:48 main interface at http://pc-linux:3000
     2022/11/25 09:11:48 admin interface at http://pc-linux:3000/admin
    
  4. Access the administrative dashboard to finalize the configuration.

Note that the default password is rdio-scanner

admin dashboard login\

  1. Configure your Rdio Scanner instance.

admin dashboard todos\

Advanced customizations

Listening on an alternate port

Here we want our Rdio Scanner instance to listen for connections on the standard HTTP port.

Because privileged ports requires root privileges, we need to run the command as root.

    [rdio@pc-linux rdio-scanner]$ sudo ./rdio-scanner -listen :80
    [sudo] password for rdio: 
    
    Rdio Scanner v6.6.3
    ----------------------------------
    2022/11/25 09:14:00 server started
    2022/11/25 09:14:00 main interface at http://pc-linux
    2022/11/25 09:14:00 admin interface at http://pc-linux/admin

Listening on a SSL port

It is recommended to share your 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@pc-linux rdio-scanner]$ sudo ./rdio-scanner \
    > -listen :80                                     \
    > -ssl_cert_file mycert.crt                       \
    > -ssl_key_file mykey.key                         \
    > -ssl_listen :443
    [sudo] password for rdio: 
    
    Rdio Scanner v6.6.3
    ----------------------------------
    2022/11/25 09:16:47 server started
    2022/11/25 09:16:47 main interface at http://pc-linux
    2022/11/25 09:16:47 main interface at https://pc-linux
    2022/11/25 09:16:47 admin interface at https://pc-linux/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 is running. The advantage of this approach is that everything is done automatically, no certificate request, no certificate renewal.

    [rdio@pc-linux rdio-scanner]$ sudo ./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@pc-linux rdio-scanner]$ ./rdio-scanner \
    > -listen :80                                \
    > -ssl_auto_cert mydomain.com                \
    > -ssl_listen :443                           \
    > -config_save
    2022/11/25 09:19:29 rdio-scanner.ini file created

All of your parameters passed as arguments to 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 without any arguments.

    [rdio@pc-linux rdio-scanner]$ sudo ./rdio-scanner 
    [sudo] Mot de passe de rdio : 
    
    Rdio Scanner v6.6.3
    ----------------------------------
    2022/11/25 09:20:40 server started
    2022/11/25 09:20:40 main interface at http://pc-linux
    2022/11/25 09:20:40 main interface at https://pc-linux
    2022/11/25 09:20:40 admin interface at https://pc-linux/admin

Install Rdio Scanner as a service

Everything looks ok now, but you do not want to manualy start 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@pc-linux rdio-scanner]$ sudo ./rdio-scanner -service install
    [sudo] Mot de passe de rdio : 
    [rdio@pc-linux rdio-scanner]$ sudo ./rdio-scanner -service start
    [rdio@pc-linux rdio-scanner]$ ps ax | grep rdio
     107957 ?        Ssl    0:00 /home/chuot/rdio-scanner/rdio-scanner -service run
     107976 pts/0    S+     0:00 grep --color=auto rdio

\pagebreak{}

Get the full list of arguments

To get the whole list of arguments you can pass to Rdio Scanner, simply pass the argument -h.

    [rdio@pc-linux 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
      -cmd string
            advanced administrative tasks (use -cmd help for usage)
      -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@pc-linux rdio-scanner]$

\pagebreak{}

Need help ?

You can ask your questions or post your comments on the Rdio Scanner Discussions at https://github.com/chuot/rdio-scanner/discussions.

Show your appreciation, support the author

If you like Rdio Scanner, consider starring the GitHub repository to show you appreciation to the author for his hard work. It cost nothing but is really appreciated.

If you use Rdio Scanner for commercial purposes or derive income from it, sponsor the project to help support continued development.

Follow us on Twitter

Commercial support

Commercial support is available at https://saubeo.solutions/.

Happy Rdio scanning !

\pagebreak{}

Clone this wiki locally