Getting Started

The instructions below are for Windows. If you're on macOS or Linux, visit our self-hosting page to get started with Docker.

Download Windows binaries

Windows-specific binaries can be downloaded here: https://files.visualdb.com/downloads/reportr.zip

After downloading the zip file, unzip it. Inside, you will find reportr.cmd. This is the script we will run, but first we need to set some environment variables.

Environment variables

The following environment variables are required. You can get a replacement for reportr.cmd that sets these environment variables from https://app.reportr.com/self-host


    set VDB_API_KEY=********************************
    set VDB_ENCRYPTION_KEY=**********************
    set VDB_HOST_ID=******************************
    set VDB_TOKEN_SECRET=*********************************
    set VDB_SITE_URL=http://0.0.0.0:8085
    set VDB_DATA_DIR=%PUBLIC%\Documents\Reportr
                            

Run Reportr

Open a command prompt and change directory to the folder containing reportr.cmd. Then run reportr.cmd.

Visit your Reportr server

Start your web browser and point it to http://localhost:8085

To log in, use the account you used to generate the environment variables above.

Next steps

If you are able to open Reportr in your browser, the next step is to open the port in Windows Firewall. This is needed to access the website from other computers on your intranet.

If you are using Reportr in a production setting, you must set up an SSL certificate. See the ReadMe file in the Reportr folder for instructions.

Contact support if you need help!