Skip to main content

RentalTide Scan License Client – Help Document

Updated over 2 months ago

Overview

The RentalTide Scan License Client is a local application that allows you to securely transmit scanned ID/license data from your computer’s USB-connected scanner to our cloud servers. This client runs on your local machine and connects to our web application through localhost. When you scan a license, the data is encrypted and sent to our servers, just as if you were adding a renter manually.

Why You Need the Local Client

  • Secure Data Transmission: Since your scanners are plugged into your computer’s USB port, we need a secure method to capture and transmit that information to our cloud. The local client encrypts the data before sending it.

  • Local Processing: The scan license function operates locally on your computer. It ensures the data is ready for transmission without delay—similar to how renter data is processed.

Installation Steps

1. Download the Client

  • Visit Our GitHub Repository:

  • Go to github.com/RentalTide/GoScanRentalTide.

  • On the right-hand side, click on the Releases tab.

  • Download the Latest Version:

  • Locate the most recent release (e.g., version 1) and download the appropriate executable:

For Windows and Linux, click directly on the GoScanRentalTide executable.

For macOS, download the file. (Note: macOS might block the app because it is not notarized.)

Installing on macOS

If macOS prevents the app from running due to security restrictions:

1. Open System Preferences:

Go to System Preferences > Security & Privacy > General.

2. Allow the App:

At the bottom of the window, you’ll see a message stating that the app was blocked. Click Open Anyway to allow the application to run.

3. Unzip

If you downloaded a compressed file (ZIP), unzip it to access the executable.

Running the Application

1. Start the Client:

  • Windows/Linux: Double-click the executable.

  • macOS: After allowing the app in System Preferences, open the executable.

2. Keep the Client Open:

Once started, the client will serve an HTTP server on localhost:3500. This window must remain open while you are scanning.

3. Verify Operation:

When running, the client displays a message similar to:

Now serving on http://localhost:3500

You can then click the Scan button in your web application. The scan license function will read the ID, and if scanned within the proper time window, it will transmit all of the necessary information for adding a renter.

Using the Scan License Function

  • When you click Scan in your web application, the local client captures and processes the license data.

  • The data is encrypted and transmitted to our servers.

  • If the scan is successful, all the license information (e.g., name, address, date of birth, etc.) will be displayed for you to add a renter.

Getting Help

If you have any questions or encounter issues, please reach out to support:

  • Contact Support: Use the Contact Support option on the left-hand side of the web application.

Did this answer your question?