proximity-matcher
Webservice for proximity matching based on TLSH and vantage point trees.
Declared in: projects/proximity-matcher/default.nix
Demo
Implement missing demoOptions
services.proximity-matcher
- 
  
  
Whether to enable proximity-matcher.
- Type:
 boolean- Default:
 false- Declared in:
 - projects/proximity-matcher/module.nix
 
 - 
  
  
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- Declared in:
 - projects/proximity-matcher/module.nix
 
 - 
  
  
Path to the pickle with TLSH hashes.
- Type:
 absolute path- Declared in:
 - projects/proximity-matcher/module.nix
 
 - 
  
  
The address the webservice should listen on.
- Type:
 string- Default:
 "127.0.0.1"- Declared in:
 - projects/proximity-matcher/module.nix
 
 - 
  
  
The port the webservice should listen on.
- Type:
 16 bit unsigned integer; between 0 and 65535 (both inclusive)- Default:
 5000- Declared in:
 - projects/proximity-matcher/module.nix
 
 - 
  
  
Whether to use the optimized version of the server.
- Type:
 boolean- Default:
 true- Declared in:
 - projects/proximity-matcher/module.nix
 
 - 
  
  
The package to use.
- Type:
 package- Default:
 - Declared in:
 - projects/proximity-matcher/module.nix
 - Notes:
 - Missing update script An update script is required for automatically tracking the latest release.
 
 - 
  
  
The timeout in seconds for workers of the optimized server.
- Type:
 signed integer- Default:
 60- Declared in:
 - projects/proximity-matcher/module.nix
 
 - 
  
  
The number of workers gunicorn should use.
- Type:
 signed integer- Default:
 4- Declared in:
 - projects/proximity-matcher/module.nix
 
 
services.proximity-matcher.enable
services.proximity-matcher.hashesPath
services.proximity-matcher.hashesPicklePath
services.proximity-matcher.listenAddress
services.proximity-matcher.listenPort
services.proximity-matcher.optimized
services.proximity-matcher.package
services.proximity-matcher.timeout
services.proximity-matcher.workers
Examples
basic
{ ... }: { services.proximity-matcher = { enable = true; hashesPicklePath = "/var/lib/proximity-matcher/hashes.pickle"; hashesPath = "/var/lib/proximity-matcher/hashes"; }; }
Declared in: projects/proximity-matcher/example.nix
This project is funded by NLnet through these subgrants: