Redact License Server (RLS): Getting started offline

In this guide, you will learn:

• What the Redact License Server (RLS) is and why it is used
• How to install and configure the RLS Server
• How to install and manage credit licenses
• How to verify that your RLS setup is operational

How to install the RLS server

Before you start installing, please speak with your contact person at Brighter AI Technologies GmbH if the RLS is suited for your use case. After this has been evaluated, meet all the requirements below.

1. Requirements
   • the Redact Enterprise Orchestration runs in a network environment that can reach the future RLS deployment
   • the machine for deploying the RLS runs docker and has temporary outbound internet access
   • your Brighter AI contact person provided you
     • the RLS documentation
     • your password for the docker registry docker.brighter.ai
     • the bash script run_reporter.sh
     • the rls license file rls_license.bal
2. Download the Docker Image
   • Log in to the Brighter AI Docker Registry using the provided credentials
     docker login docker.brighter.ai -u enterprise -p <password>
   • Pull the Redact License Server image:
     docker pull docker.brighter.ai/redact-license-server:1.1.4
   • Make sure with your Brighter AI contact person which RLS version you should be running
3. Start the RLS Server
   • Execute the run_reporter.sh script provided by Brighter AI to start the RLS Server:
     ./run_reporter.sh
   • The RLS Server will now run on the host exposed as 0.0.0.0
   • To use a different interface of the host machine, change the 0.0.0.0 in the script

Now, the RLS applications are running as Docker containers. You can check this with the command docker ps. Follow the detailed explanation below to set up RLS with its licenses. Afterwards, it is ready for reporting the consumption of the Brighter Redact Orchestration solution.

Installing the RLS License

The RLS application requires a general RLS license. This needs to be installed only once for each RLS instance.

• After receiving the rls_license.bal file from your Brighter AI contact, install it using the following command:

curl -X 'POST' \
'http\://<host-ip>:8700/api/license/server/install'  \
-H 'accept: application/json'  \
-H 'Content-Type: multipart/form-data'  \
-F 'license=@rls_license.bal'

• Replacing of the <host-ip>
  • If the RLS is running on the 127.0.0.1 interface locally, use 127.0.0.1:8700
  • If the RLS is running on the 0.0.0.0 interface locally, use hostname -I to identify your host IP. Afterwards, you can set it as <host-ip>:8700.

Installing a Credit License

The RLS application requires Credit Licenses to be able to report consumption that it receives by the Redact Enterprise Orchestration solution. The Credit Licenses have an expiration date and only a limited amount of credits, that are deducted after each reporting step.

1. Generate a Credit Request
   • Generate a request file for the number of credits you need:
   Shell

   curl -X 'GET'  \
   'http\://<host-ip>:8700/api/license/credit/request?credits=<Amount>'  \
   -H 'accept: application/json' > request.req
   

   • Replace <host-ip> as described in Installing the RLS License
   • Replace <Amount> with the number of credits required (e.g. 1.000.000 for 1 million frames).
   • Send the generated request.req file to your Brighter AI contact. They will provide a credit license file based on your request.
2. Add the Credit License
   • After receiving the credit license file (e.g., credit_license.bal), install it with the following command
   Shell

   curl -X 'POST'  \
     'http\://<host-ip>:8700/api/license/credit/add'  \
     -H 'accept: application/json'  \
     -H 'Content-Type: multipart/form-data'  \
     -F 'license=@credit_license.bal'
   

   
   
3. Verify Credit Status
   • Check whether the credits have been successfully added:
   Shell

   curl -X 'GET'  \
   'http\://<host-ip>:8700/api/license/credit/status'  \
   -H 'accept: application/json'
   

   • You should receive a 200 response that shares the status of the installed license. Make sure that the requested amount of credits is matching the amount of credits in the status response.

Start redacting and create a report

• Now that the installation is complete, do a test processing of some file via the Redact Enterprise Orchestration.
• Wait until the processing is completed. After this, you can create a report.
• The report endpoint of the RLS requires the <start-date> and <end-date> which must be given in format of YYYY-MM-DD. Please adjust this to the date of your processing. <start-date> can be equals <end-date> only this day is then returned.

curl -X 'GET' \
   'http://<host-ip>:8700/api/download_report?filetype=csv&start_date=<start-date>&end_date=<end-date>' \
   -H 'accept: application/json' > test.csv

• After creating the report, check if the processing was reported.

Troubleshooting

If you encounter any issues during the installation or setup, please reach out to our team. We’ll assist you during the onboarding call to ensure a smooth deployment.