Rport Frontend

Rport comes with a web-based graphical user interface (frontend) which is distributed as a separate bundle.

WARNING

Only the rport command-line tools – rport server and rport client – are released under the open-source MIT license. The optional graphical user interface is NOT open-source, and free to use only under certain circumstances.

In short, the following is not covered by the licenseopen in new window and requires acquiring a commercial license.

  • Building a SaaS product or offering a hosted version of rport, either paid or free.
  • Running rport and the UI and granting customers access to it, either paid or free.

Free usage in a company is allowed, as long as only employees of the company have access to rport. Read the full licenseopen in new window. The uncompressed source code is not published.

Installing the frontend

The frontend comes as a minified and compressed bundle of Javascript files and all needed assets. The frontend does not require any server-side scripting support. The rport server provides static file serving for that purpose.

By default, the built-in web server listens only on localhost. Serving a web frontend on localhost is not very useful. Change the listen address of the API to "0.0.0.0:3000" or any port you like.

Make sure you have the below options enabled in [api] section of the rportd.conf.

[api]
  address = "0.0.0.0:3000"  
  doc_root = "/var/lib/rport/docroot"

DANGER

Usually you run rportd and the web frontend on a public server directly exposed to the internet. Running the API and serving the frontend on unencrypted HTTP is dangerous. Always use HTTPs. The built-in web server supports HTTPs. To quickly generate certificates, follow this guide.

mkdir /var/lib/rport/docroot
cd /var/lib/rport/docroot
wget -q https://downloads.rport.io/frontend/stable/latest.php -O rport-frontend.zip
unzip -qq rport-frontend.zip && rm -f rport-frontend.zip
cd ~
chown -R rport:rport /var/lib/rport/docroot

Now open the API-URL in a browser. Log in with a username and password specified for the API authentication.

You are done.

Last Updated:
Contributors: Mykola Terelia, Thorsten Kramm, Andrey, Birgit Karch, Mykola Terelia