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

chore: remove kms from docs #768

Merged
merged 2 commits into from
Sep 3, 2024
Merged

chore: remove kms from docs #768

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad134d0
chore: remove kms from docs
martinsaporiti Sep 3, 2024
b330a7b
chore: add ISSUER_UNIVERSAL_LINKS_BASE_URL var
martinsaporiti Sep 3, 2024
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
7 changes: 1 addition & 6 deletions .env-issuer.sample
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,13 @@ ISSUER_ENVIRONMENT=local
# --------------------------------------------------------------------------------
# KMS configuration
# --------------------------------------------------------------------------------
# Could be either [localstorage | vault] (BJJ) and [localstorage | vault | aws ] (ETH)
# Could be either [localstorage | vault] (BJJ) and [localstorage | vault ] (ETH)
ISSUER_KMS_BJJ_PROVIDER=localstorage
ISSUER_KMS_ETH_PROVIDER=localstorage

# if the plugin is localstorage, you can specify the folder path
ISSUER_KMS_PROVIDER_LOCAL_STORAGE_FILE_PATH=./localstoragekeys

# If the provider is AWS for ETH keys you need to specify the key id and secret key
ISSUER_KMS_ETH_PLUGIN_AWS_ACCESS_KEY=XXX
ISSUER_KMS_ETH_PLUGIN_AWS_SECRET_KEY=YYY
ISSUER_KMS_ETH_PLUGIN_AWS_REGION=eu-west-1

# if one of the plugins is vault, you have to specify the vault address and token
ISSUER_KEY_STORE_ADDRESS=http://vault:8200
ISSUER_KEY_STORE_PLUGIN_IDEN3_MOUNT_PATH=iden3
Expand Down
17 changes: 0 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,23 +178,6 @@ ISSUER_KMS_ETH_PROVIDER=localstorage

To import the private key necessary to transition onchain states, the command is the same as [explained before](#install-and-run-issuer-node-api-and-ui).

#### Running issuer node with AWS KMS Service instead of Vault for ETH Keys
Another alternative for eth keys associated with the identities created in the issuer node is to use the AWS KMS service.
In this case you have to change some variables in the .env-issuer file:

```bash
ISSUER_KMS_BJJ_PROVIDER=<localstorage or vault>
ISSUER_KMS_ETH_PROVIDER=aws
ISSUER_KMS_ETH_PLUGIN_AWS_ACCESS_KEY=<AWS-ACCESS-KEY>
ISSUER_KMS_ETH_PLUGIN_AWS_SECRET_KEY=<AWS-SECRET-KEY>
ISSUER_KMS_ETH_PLUGIN_AWS_REGION=<AWS-REGION>
```

In this case, to import the private key in AWS KMS run:
```shell
make private_key=XXX aws_access_key=YYY aws_secret_key=ZZZ aws_region=your-region import-private-key-to-kms
```

## Quick Start Demo

This [Quick Start Demo](https://devs.polygonid.com/docs/quick-start-demo/) will walk you through the process of **issuing** and **verifying** your **first credential**.
Expand Down
Loading