proximity-matcher

Webservice for proximity matching based on TLSH and vantage point trees.

Options

services.proximity-matcher
services.proximity-matcher.enable

Whether to enable proximity-matcher.

Type:
boolean
Default:
false
services.proximity-matcher.hashesPath

Path to a file with TLSH hashes, formatted as one hash per line.

It is only used with the optimized version of the server.

Type:
null or absolute path
Default:
null
services.proximity-matcher.hashesPicklePath

Path to the pickle with TLSH hashes.

Type:
absolute path
services.proximity-matcher.listenAddress

The address the webservice should listen on.

Type:
string
Default:
"127.0.0.1"
services.proximity-matcher.listenPort

The port the webservice should listen on.

Type:
16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
5000
services.proximity-matcher.optimized

Whether to use the optimized version of the server.

Type:
boolean
Default:
true
services.proximity-matcher.package

The package to use.

Type:
package
Default:
services.proximity-matcher.timeout

The timeout in seconds for workers of the optimized server.

Type:
signed integer
Default:
60
services.proximity-matcher.workers

The number of workers gunicorn should use.

Type:
signed integer
Default:
4

Examples

Sets up proximity-matcher with a basic configuration for TLSH and a location with known hashes. 
{ ... }:
{
  services.proximity-matcher = {
    enable = true;
    hashesPicklePath = "/var/lib/proximity-matcher/hashes.pickle";
    hashesPath = "/var/lib/proximity-matcher/hashes";
  };
}