Configuration

Blurit CLI

The Blurit CLI is installed during the Linux or Windows dependencies installation process. This command will prompt you with several questions to assist in setting up your Blurit installation. If Blurit team send you a compose file, it's possible to pass it as argument.

blurit configure [DOCKER_COMPOSE]

Configuration explanation

The following section provides an explanation of the various questions asked during the configuration process.

API port

Select the port for the API to operate on the server. You can find the API documentation here.

Web app

Choose the port for the Web app to run on the server. The Web app documentation can be found here.

Local storage

These settings define the base directories where BlurIt OP will locate input files (to be processed) and where it will store the output files (blurred videos/images and detection JSONs) on the local server storage, i.e., on the server where BlurIt OP is running.

S3 storage

These settings allow the use of S3 storage for the input and output directories for media.

GPU settings

Select the GPU you wish to use with Blurit.

Max Threads number

This variable represents the maximum number of threads that the reencoding step will utilize on your CPU. Increasing this value can result in faster reencoding.

However, it's important to note that you should reserve some threads for other processes.

Avoid using the maximum number of available threads on your server, as it may impact the performance of other applications.

Webhook (optional)

This setting is a configuration that defines a route or URL where a POST request can be sent. This endpoint is typically used to send JSON data to another system or service.

In this specific example, when the POST request is made to the "CUSTOM_WEBHOOK_ENDPOINT" route, the JSON payload being sent is as follows:

{
  "status": "Succeeded",
  "task_id": "abc-123-456-789"
}

The JSON payload contains two key-value pairs:

• "status" with a value of "Succeeded"

• "task_id" with a value of "abc-123-456-789"

The purpose of this webhook is to notify or provide information to the system or service listening at the specified endpoint about the status of a task or operation. The receiving system can then process this data according to its requirements.

Manager api port

Choose the port for the manager API to run on the server. Please note that API documentation for the manager API is not available.

Jobs timeouts

This parameter represents the amount of time the application waits before changing the status of a task to "failed." By default, it is set to 43200000 milliseconds (equivalent to 12 hours).