Home

Welcome to the reg-pilot wiki!

Compatibility Matrix

Service	Version	Compatible Verifier Versions	Compatible API Versions	Compatible Filer Versions	Compatible Router Versions
Verifier	0.0.3	-	0.0.2, 0.0.1-legacy	0.0.1, 0.0.2	-
Verifier	0.0.4	-	0.0.2, 0.0.1-legacy	0.0.1, 0.0.2	-
Verifier	0.1.0	-	0.1.0	0.1.0	0.1.0
Verifier	0.1.1	-	0.1.0	0.1.0	0.1.0
Verifier	0.1.2	-	-	0.1.0	0.1.1
Verifier	0.1.3	-	-	0.1.0	0.1.1
Router	0.1.0	0.1.1	0.1.0	0.1.0	-
Router	0.1.1	0.1.2, 0.1.3	-	-	-
API	0.0.1-legacy	0.0.3, 0.0.4	-	-	-
API	0.0.2	0.0.3, 0.0.4	-	0.0.1, 0.0.2	-
API	0.0.3	0.0.3, 0.0.4	-	0.0.1, 0.0.2	-
API	0.1.0	0.1.0, 0.1.1	-	0.1.0	0.1.0
Filer	0.0.1	0.0.3, 0.0.4	0.0.2	-	-
Filer	0.0.2	0.0.3, 0.0.4	0.0.2	-	-
Filer	0.1.0	0.1.0, 0.1.1	0.1.0	-	0.1.0

Legacy combinations(with no Filer):

Verifier	API	Filer
0.0.3	0.0.1-legacy	-
0.0.4	0.0.1-legacy	-

Environment setup:

reg-pilot-api setup:

ENV Variable	Defaults	Versions	Description
VERIFIER_AUTHORIZATIONS	http://vlei-verifier:7676/authorizations/	0.0.1-legacy, 0.0.2, 0.0.3	The vlei-verifier endpoint where reg-pilot-api sends credential authorization requests. This is used to check whether an AID has a valid and authorized vLEI credential.
VERIFIER_PRESENTATIONS	http://vlei-verifier:7676/presentations/	0.0.1-legacy, 0.0.2, 0.0.3	The vlei-verifier endpoint where reg-pilot-api sends credential presentation requests. It allows clients to present credentials to perform cryptographic verification.
VERIFIER_REPORTS	http://vlei-verifier:7676/reports/	0.0.1-legacy	The vlei-verifier endpoint where reg-pilot-api sends requests to upload report/retrieve report status.
VERIFIER_REQUESTS	http://vlei-verifier:7676/request/verify/	0.0.1-legacy, 0.0.2, 0.0.3	The vlei-verifier endpoint where reg-pilot-api sends signed header verification requests.
VERIFIER_ADD_ROT	http://vlei-verifier:7676/root_of_trust/	0.0.1-legacy, 0.0.2, 0.0.3	The vlei-verifier endpoint where reg-pilot-api sends requests to add Root of Trust (RoT).
FILER_REPORTS	http://reg-pilot-filer:7878/reports/	0.0.2, 0.0.3, 0.1.0	The reg-pilot-filer endpoint where reg-pilot-api sends requests to upload report/retrieve report status.
FILER_ADMIN_UPLOAD_STATUSES	http://vlei-verifier:7676/root_of_trust/	0.0.2, 0.0.3, 0.1.0	The reg-pilot-filer endpoint where reg-pilot-api sends requests to retrieve report upload statuses for the Data Admin.
VLEI_VERIFIER	http://vlei-verifier:7676/	0.1.0	Base URL for the vLEI Verifier service.

vlei-verifier setup:

ENV Variable	Defaults	Versions	Description
VERIFIER_CONFIG_FILE	verifier-config-public.json	0.0.3, 0.0.4, 0.1.0	Specifies the configuration file for the verifier. Users can set this to an available config file or provide a custom configuration.
VERIFIER_ENV	production	0.0.3, 0.0.4, 0.1.0	Defines the environment mode (dev or production). In production mode, the /root_of_trust endpoint is disabled for security.
VERIFY_ROOT_OF_TRUST	True	0.0.3, 0.0.4, 0.1.0	Enables or disables root of trust validation
KERI_BASER_MAP_SIZE	104857600 (~100 MB)	0.0.3, 0.0.4, 0.1.0	Sets the maximum size for the LMDB database used by the verifier.
FILER_CHUNK_SIZE	4194304 (~4MB)	0.0.3, 0.0.4, 0.1.0	Configures the chunk size for file processing, optimizing memory usage for handling large files.

reg-pilot-filer setup:

ENV Variable	Defaults	Versions	Description
VLEI_VERIFIER	http://vlei-verifier:7676	0.0.1, 0.0.2, 0.1.0	Base URL for the vLEI Verifier service.
KERI_BASER_MAP_SIZE	104857600 (~100 MB)	0.0.1, 0.0.2, 0.1.0	Sets the maximum size for the LMDB database used by the verifier.
FILER_CHUNK_SIZE	4194304 (~4MB)	0.0.1, 0.0.2, 0.1.0	Configures the chunk size for file processing, optimizing memory usage for handling large files.

Deployment Logs

For the deployment history of the remote services, see the DEPLOYMENTS.md file.