Installation Instructions

Server

To install a prebuilt release of the FRC Detective Server application, which has been tested and verified to work, download it from our website, and upload it to your server/computer.

For the Server to work, you’ll need to have the Docker engine installed on your system. If you don’t already have it, read the instructions here. For Linux systems, you’ll want the Docker Engine, and Windows/Mac users will need to install the Docker Desktop application.

Once Docker’s installed, grab a copy of the latest Server Release from our Download Page.

Linux and macOS Instructions:

Move to your Downloads directory and run unzip ./DetectiveServer-Release.zip && cd DetectiveServer-Release. Now that you’re in the directory, run ./install-linux.sh (not as root, but as your default user.) If prompted, enter your user password for the sudo command.

Inside the Installation Script, we’ll load the docker image in, copy the required files to /etc/detective on your disk, and install a frcdetective binary that you can launch from the command line once finished.

When prompted, enter the timezone you use from the TZ Database (see here if unsure), and the port you would like to access the Web UI from. By default we recommend using Port 8080, but if your system is used exclusively for the FRC Detective, Port 80 might be easier, as you can access the UI directly, without using http://address:port/.

After the installation is complete, you can start the server by running sudo frcdetective, and log onto the web server by going to localhost, or your system’s external IP. The first user to login to the Web Interface will automatically be given Administrator Permissions, and afterwards more users can be added to the Admin Console by the initial user, after they register.