Setting up environment parameters

.env / .env.docker Parameters in guardian-service

Parameter	Purpose	Example
MQ_ADDRESS	Web Socket Address	localhost
SERVICE_CHANNEL	Version of the Guardian	guardian.1
DB_HOST	Hostname of the Database	localhost
DB_DATABASE	Database Name	guardian_db
INITIAL_BALANCE	Initial Balance Value	500
INITIAL_STANDARD_REGISTRY_BALANCE	Setting Initial Standard Registry Balance	500
OPERATOR_ID	The ID of the operation	-
OPERATOR_KEY	Private key of the operator	-
LOCALNODE_ADDRESS	The address of the localnode server. This can be its IP address or a domain name	1.1.1.1
LOCALNODE_PROTOCOL	Communication protocol for interactions with the local node, can be http or https.	http/https
HEDERA_NET	Type of the Hedera node to transact with	testnet, localnode, mainnet
INITIALIZATION_TOPIC_ID	The ID of the initialization topic.	0.0.1960
MESSAGE_LANG	Language of the message text of all messages	en-US
LOG_LEVEL	Level of the Logs	2
SEND_KEYS_TO_VAULT	Checked if keys to be sent to vault	True/False
MULTI_POLICY_SCHEDULER	to set custom cron mask (timer mask) for sync job	0 0 * * *
MQ_MESSAGE_CHUNK	To set up the message chunk size	500000
HEDERA_CUSTOM_NODES	Define hedera nodes to execute and pay transaction fee	0.testnet.hedera.com:50211":"0.0.3
HEDERA_CUSTOM_MIRROR_NODES	Define hedera mirror nodes	testnet.mirrornode.hedera.com:443"
MAP_API_KEY	Defines api to integrate Map schema type	ALZ_X.....
DOCUMENT_CACHE_FIELD_LIMIT	Defines document field symbols limit for caching.	500
BATCH_NFT_MINT_SIZE	Defines size of batch of mint NFT transaction	10
DIRECT_MESSAGE_PORT	Port for direct messages (if not set generate random port)	300
DIRECT_MESSAGE_HOST	Host for direct messages (if not set get hostname)	localhost
DIRECT_MESSAGE_PROTOCOL	Protocol https or http (http by default, https need additional server like nginx)	http
MQ_MAX_PAYLOAD	Max message size for send via message-broker (otherwise create direct message) if not set always send messages using message broker	35
RETIRE_CONTRACT_FILE_ID	Contract file ID for Retirement	0.0.4860665
WIPE_CONTRACT_FILE_ID	Contract file ID for wiping	0.0.4726865
DOCUMENTS_HANDLING_CHUNK_SIZE	To set chunk size for delete or create a lot of data (value will affect speed performance communication with DB), default is 500.	500
ALLOWED_PROTOCOLS="https"	This variable defines the list of allowed protocols that can be used in outbound HTTP requests made by the httpRequestBlock.	https
BLOCK_PRIVATE_IP	This variable controls whether the httpRequestBlock should reject outbound requests to private or sensitive IP address ranges.	True/False

Important Note:

1. Values from .env file need to be set up only on first start (when db or vault are empty). Then later if you want it to be changed, you can change it through Settings from admin Panel or through API.

2. Now we have upgraded DB_HOST (in guardian and indexer), DB_LOGGER_HOST (in guardian) settings and now it allows to set up Mongo Atlas connection string like mongodb+srv://.... which means that if you are explicitly setting up protocol it will be automatically applied OR if your using only host and port, it will automatically add mongodb:// (backward compatibility)

3. ALLOWED_PROTOCOLS:

By default, only the https protocol is allowed: ALLOWED_PROTOCOLS="https"

To allow multiple protocols, add them as a comma-separated list. For example: ALLOWED_PROTOCOLS="https,http"

If a user attempts to use a protocol that is not explicitly listed, the request will be blocked during policy validation.

1. BLOCK_PRIVATE_IP:

By default, this value is set to "false", under the assumption that Guardian is not operating in an environment where internal services are exposed over https and accessible via external requests.

BLOCK_PRIVATE_IP="false"

To enforce strict protection and block all requests to private or loopback IP addresses, set the variable to:

BLOCK_PRIVATE_IP="true"

.env / .env.docker Parameters in api-gateway

Parameter	Purpose	Example
MQ_ADDRESS	Web Socket Address	message-broker
SERVICE_CHANNEL	Channel of the service	api-gateway
MRV_ADDRESS	MRV Address location	http://message-broker/mrv
MQ_MESSAGE_CHUNK	To set up the message chunk size	500000
RAW_REQUEST_LIMIT	Define request limit	1 gb
JSON_REQUEST_LIMIT	Define limit for body in Json format	1 gb
DIRECT_MESSAGE_PORT	Port for direct messages (if not set generate random port)	300
DIRECT_MESSAGE_HOST	Host for direct messages (if not set get hostname)	localhost
DIRECT_MESSAGE_PROTOCOL	Protocol https or http (http by default, https need additional server like nginx)	http
MQ_MAX_PAYLOAD	Max message size for send via message-broker (otherwise create direct message) if not set always send messages using message broker	35

.env / .env.docker Parameters in auth-service

Parameter	Purpose	Example
SR_INITIAL_PASSWORD	Allows to set SR initial password when it will be created first time. It also should have more than 5	Env!s!0n!@
MIN_PASSWORD_LENGTH	Sets the minimum password length. Default value is 8, minimum value is 1	8
PASSWORD_COMPLEXITY	Sets the password complexity level Default value is medium Available values: easy, medium, hard easy - no rules medium - one uppercase letter, one lowercase letter, one number hard - one uppercase letter, one lowercase letter, one number, one special character	medium