Skip to content

Commit

Permalink
Change to table
Browse files Browse the repository at this point in the history
  • Loading branch information
Shota Jolbordi committed Aug 24, 2023
1 parent f27c37c commit 45a4720
Showing 1 changed file with 49 additions and 194 deletions.
243 changes: 49 additions & 194 deletions documentation/docs/atala-prism/prism-cloud-agent/environment-variables.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,197 +3,52 @@

The following enviroment variables can be used to configure Prism Agent:


* `DEV_MODE`
- Type: `Boolean`
- Default: `false`
- Description: Used to indicate if the agent is running in production or dev enviroment.
* `IRIS_HOST`:
- Type: `String`
- Default: `localhost`
- Description: Hostname of the Iris server an agent will us to connect to.
* `IRIS_PORT`:
- Type: `Int`
- Default: `8081`
- Description: Port of the Iris host an agent will use to connect to.
* `CASTOR_DB_HOST`
- Type: `String`
- Default: `localhost`
- Description: Hostname of the server where castor database is running on.
* `CASTOR_DB_PORT`
- Type: `Int`
- Default: `5432`
- Description: Port of the castor database
* `CASTOR_DB_NAME`
- Type: `String`
- Default: `castor`
- Description: Database name where castor db will store data
* `CASTOR_DB_USER`
- Type: `String`
- Default: `postgres`
- Description: Castor databse username for login
* `CASTOR_DB_PASSWORD`
- Type: `String`
- Default: `postgres`
- Description: Castor databse password for login
* `POLLUX_DB_HOST`
- Type: `String`
- Default: `localhost`
- Description: Hostname of the server where pollux database is running on.
* `POLLUX_DB_PORT`
- Type: `Int`
- Default: `5432`
- Description: Port of the pollux database
* `POLLUX_DB_NAME`
- Type: `String`
- Default: `pollux`
- Description: Database name where pollux db will store data
* `POLLUX_DB_USER`
- Type: `String`
- Default: `postgres`
- Description: Pollux databse username for login
* `POLLUX_DB_PASSWORD`
- Type: `String`
- Default: `postgres`
- Description: Pollux databse password for login
* `ISSUE_BG_JOB_RECORDS_LIMIT`
- Type: `Int`
- Default: `25`
- Description: Maximum number of records issue credentials job will try to process at the same time
* `ISSUE_BG_JOB_RECURRENCE_DELAY`
- Type: `String`
- Default `2 seconds`
- Description: Interval at which issue credentials job will try to process records
* `ISSUE_BG_JOB_PROCESSING_PARALLELISM`
- Type: `Int`
- Default: `5`
- Description: Maximum amount of parallel issue credential job processings
* `PRESENTATION_BG_JOB_RECORDS_LIMIT`
- Type: `Int`
- Default: `25`
- Description: Maximum number of records present proof job will try to process at the same time
* `PRESENTATION_BG_JOB_RECURRENCE_DELAY`
- Type: `String`
- Default `2 seconds`
- Description: Interval at which present proof job will try to process records
* `PRESENTATION_BG_JOB_PROCESSING_PARALLELISM`
- Type: `Int`
- Default: `5`
- Description: Maximum amount of parallel present proof job processings
* `CONNECT_DB_HOST`
- Type: `String`
- Default: `localhost`
- Description: Hostname of the server where connection flow database is running on
* `CONNECT_DB_PORT`
- Type: `String`
- Default: `5432`
- Description: Port of the connection flow database
* `CONNECT_DB_NAME`
- Type: `String`
- Default: `connect`
- Description: Database name where connection flow db will store data
* `CONNECT_DB_USER`
- Type: `String`
- Default: `postgres`
- Description: Connection flow databse username for login
* `CONNECT_DB_PASSWORD`
- Type: `String`
- Default: `postgres`
- Description: Connection flow databse password for login
* `CONNECT_BG_JOB_RECORDS_LIMIT`
- Type: `Int`
- Default: `25`
- Description: Maximum number of records connect job will try to process at the same time
* `CONNECT_BG_JOB_RECURRENCE_DELAY`
- Type: `String`
- Default `2 seconds`
- Description: Interval at which connect job will try to process records
* `CONNECT_BG_JOB_PROCESSING_PARALLELISM`
- Type: `Int`
- Default: `5`
- Description: Maximum amount of parallel connect job processings
* `AGENT_HTTP_PORT`
- Type: `Int`
- Default: `8085`
- Description: Port on which prism agent runs
* `DIDCOMM_SERVICE_URL`
- Type: `String`
- Default: `http://localhost:8090`
- Description: Url of the DIDcomm server that also runs for this agent. DIDcomm messages can be sent to this agent using this URL
* `AGENT_DB_HOST`
- Type: `String`
- Default: `localhost`
- Description: Hostname of the server where prism agent database is running on.
* `AGENT_DB_PORT`
- Type: `Int`
- Default: `5432`
- Description: Port of the prism agent database
* `AGENT_DB_NAME`
- Type: `String`
- Default: `agent`
- Description: Database name where agent db will store data
* `AGENT_DB_USER`
- Type: `String`
- Default: `postgres`
- Description: Agent databse username for login
* `AGENT_DB_PASSWORD`
- Type: `String`
- Default: `postgres`
- Description: Agent databse password for login
* `CREDENTIAL_VERIFY_SIGNATURE`
- Type: `Boolean`
- Default: `true`
- Description: Whether or not to verify a credential signature
* `CREDENTIAL_VERIFY_DATES`
- Type: `Boolean`
- Default: `false`
- Description: Whether or not to verify a credential dates (expiration)
* `CREDENTIAL_LEEWAY`
- Type: `String`
- Default: `0 seconds`
- Description: time leeway when verifying credential dates, if time difference is less then a leeway, it will still verify
* `PRESENTATION_VERIFY_SIGNATURE`
- Type: `Boolean`
- Default: `true`
- Description: Whether or not to verify a signed challenge used during credential presentation
* `PRESENTATION_VERIFY_DATES`
- Type: `Boolean`
- Default: `false`
- Description: Whether or not to verify a challenge dates during presentation
* `PRESENTATION_VERIFY_HOLDER_BINDING`
- Type: `Boolean`
- Default: `false`
- Description:
* `PRESENTATION_LEEWAY`
- Type: `String`
- Default: `0 seconds`
- Description: Time leeway when verifying challenge dates.
* `SECRET_STORAGE_BACKEND`
- Type: `Enum(vault, postgres)`
- Default: `vault`
- Description: Secret storage for keys and credentials, if vault is used, vault server must be running, otherwise databse can be used for development purposes only
* `VAULT_ADDR`
- Type: `String`
- Default: `http://localhost:8200`
- Description: Url of the vault service for prism agent to use for secret management
* `VAULT_TOKEN`
- Type: `String`
- Default: `root`
- Description: `Vault service auth token`
* `WEBHOOK_URL`
- Type: `String`
- Default: `Null`
- Description: The webhook endpoint URL where the notifications will be sent.
* `WEBHOOK_API_KEY`
- Type: `String`
- Default: `Null`
- Description: The optional API key (bearer token) to use as the Authorization header.
* `WEBHOOK_PARALLELISM`
- Type: `Int`
- Default: `Null`
- Description: Maximum number of events that will be retrieved in a single iteration, from the event queue by the webhook publisher.





| Variable Name | Description | Type | Default |
|------------------------------------|-------------------------------------------------------------------------------------------------------|---------------------|-------------|
| DEV_MODE | Used to indicate if the agent is running in production or dev environment. | Boolean | false |
| IRIS_HOST | Hostname of the Iris server an agent will use to connect to. | String | localhost |
| IRIS_PORT | Port of the Iris host an agent will use to connect to. | Int | 8081 |
| CASTOR_DB_HOST | Hostname of the server where Castor database is running on. | String | localhost |
| CASTOR_DB_PORT | Port of the Castor database. | Int | 5432 |
| CASTOR_DB_NAME | Database name where Castor db will store data. | String | castor |
| CASTOR_DB_USER | Castor database username for login. | String | postgres |
| CASTOR_DB_PASSWORD | Castor database password for login. | String | postgres |
| POLLUX_DB_HOST | Hostname of the server where Pollux database is running on. | String | localhost |
| POLLUX_DB_PORT | Port of the Pollux database. | Int | 5432 |
| POLLUX_DB_NAME | Database name where Pollux db will store data. | String | pollux |
| POLLUX_DB_USER | Pollux database username for login. | String | postgres |
| POLLUX_DB_PASSWORD | Pollux database password for login. | String | postgres |
| ISSUE_BG_JOB_RECORDS_LIMIT | Maximum number of records issue credentials job will try to process at the same time. | Int | 25 |
| ISSUE_BG_JOB_RECURRENCE_DELAY | Interval at which issue credentials job will try to process records. | String | 2 seconds |
| ISSUE_BG_JOB_PROCESSING_PARALLELISM| Maximum amount of parallel issue credential job processings. | Int | 5 |
| PRESENTATION_BG_JOB_RECORDS_LIMIT | Maximum number of records present proof job will try to process at the same time. | Int | 25 |
| PRESENTATION_BG_JOB_RECURRENCE_DELAY| Interval at which present proof job will try to process records. | String | 2 seconds |
| PRESENTATION_BG_JOB_PROCESSING_PARALLELISM| Maximum amount of parallel present proof job processings. | Int | 5 |
| CONNECT_DB_HOST | Hostname of the server where connection flow database is running on. | String | localhost |
| CONNECT_DB_PORT | Port of the connection flow database. | String | 5432 |
| CONNECT_DB_NAME | Database name where connection flow db will store data. | String | connect |
| CONNECT_DB_USER | Connection flow database username for login. | String | postgres |
| CONNECT_DB_PASSWORD | Connection flow database password for login. | String | postgres |
| CONNECT_BG_JOB_RECORDS_LIMIT | Maximum number of records connect job will try to process at the same time. | Int | 25 |
| CONNECT_BG_JOB_RECURRENCE_DELAY | Interval at which connect job will try to process records. | String | 2 seconds |
| CONNECT_BG_JOB_PROCESSING_PARALLELISM| Maximum amount of parallel connect job processings. | Int | 5 |
| AGENT_HTTP_PORT | Port on which prism agent runs. | Int | 8085 |
| DIDCOMM_SERVICE_URL | URL of the DIDcomm server that also runs for this agent. | String | http://localhost:8090 |
| AGENT_DB_HOST | Hostname of the server where prism agent database is running on. | String | localhost |
| AGENT_DB_PORT | Port of the prism agent database. | Int | 5432 |
| AGENT_DB_NAME | Database name where agent db will store data. | String | agent |
| AGENT_DB_USER | Agent database username for login. | String | postgres |
| AGENT_DB_PASSWORD | Agent database password for login. | String | postgres |
| CREDENTIAL_VERIFY_SIGNATURE | Whether or not to verify a credential signature. | Boolean | true |
| CREDENTIAL_VERIFY_DATES | Whether or not to verify credential dates (expiration). | Boolean | false |
| CREDENTIAL_LEEWAY | Time leeway when verifying credential dates, if time difference is less than a leeway, it will still verify. | String | 0 seconds |
| PRESENTATION_VERIFY_SIGNATURE | Whether or not to verify a signed challenge used during credential presentation. | Boolean | true |
| PRESENTATION_VERIFY_DATES | Whether or not to verify challenge dates during presentation. | Boolean | false |
| PRESENTATION_VERIFY_HOLDER_BINDING | Description missing (please provide). | Boolean | false |
| PRESENTATION_LEEWAY | Time leeway when verifying challenge dates. | String | 0 seconds |
| SECRET_STORAGE_BACKEND | Secret storage for keys and credentials. If vault is used, the vault server must be running, otherwise a database can be used for development purposes only. | Enum(vault, postgres)| vault |
| VAULT_ADDR | URL of the vault service for prism agent to use for secret management. | String | http://localhost:8200 |
| VAULT_TOKEN | Vault service auth token. | String | root |
| WEBHOOK_URL | The webhook endpoint URL where the notifications will be sent. | String | Null |
| WEBHOOK_API_KEY | The optional API key (bearer token) to use as the Authorization header. | String | Null |
| WEBHOOK_PARALLELISM | Maximum number of events that will be retrieved in a single iteration, from the event queue by the webhook publisher. | Int | Null |

0 comments on commit 45a4720

Please sign in to comment.