Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add docs for agent env variables #50

Merged
merged 4 commits into from
Aug 25, 2023
Merged

feat: add docs for agent env variables #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ef639b2
Add docs for agent env variables
Aug 21, 2023
f27c37c
Add leftower descriptions
Aug 21, 2023
45a4720
Change to table
Aug 24, 2023
152cd4b
Merge branch 'main' into ATL-5505-docs-for-prism-agent
shotexa Aug 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions documentation/docs/atala-prism/prism-cloud-agent/environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Environment Variables


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

| 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 |
3 changes: 2 additions & 1 deletion documentation/docs/sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ const sidebars = {
'atala-prism/prism-cloud-agent/overview',
'atala-prism/prism-cloud-agent/building-blocks',
'atala-prism/prism-cloud-agent/did-management',
'atala-prism/prism-cloud-agent/secrets-storage'
'atala-prism/prism-cloud-agent/secrets-storage',
'atala-prism/prism-cloud-agent/environment-variables'
]
},
{
Expand Down