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

Document optional artifacts #164

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Document optional artifacts #164

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
83d1576
Document optional artifacts
rolandtyler Jul 6, 2022
8048428
Capitalization
rolandtyler Jul 6, 2022
18e6685
Capitalization
rolandtyler Jul 6, 2022
ef0d441
Update links
rolandtyler Jul 7, 2022
100fc02
Merge branch 'master' into artifacts
rolandtyler Oct 4, 2022
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
17 changes: 17 additions & 0 deletions docs/HowTo/Get-started/Install/Distribution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,20 @@ Copy the contents of the artifact's `/lib` into the distribution `/lib` (resolve
```bash
cp -a aws-key-vault-[version]/lib/. tessera-[version]/lib/
```

#### Available optional artifacts

The following artifacts can be added to a distribution to provide additional functionality.

##### Key Vaults

- [Azure](https://github.com/ConsenSys/tessera/tree/master/key-vault/azure-key-vault): Adds support for key pairs stored in Azure Key Vault.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These aren't links to artifacts. To get the artifacts you have to go to dockerhub eg https://hub.docker.com/r/quorumengineering/tessera/tags?page=1&name=aws

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we don't want to link to dockerhhub here. This page is for installing by binary distribution. The section just above this is how to add the artifacts from the .jar files. This was to list the artifacts (and their repo folders), matching the info on the Tessera readme.

- [AWS](https://github.com/ConsenSys/tessera/tree/master/key-vault/aws-key-vault): Adds support for key pairs stored in AWS Secret Store.
- [HashiCorp](https://github.com/ConsenSys/tessera/tree/master/key-vault/hashicorp-key-vault): Adds support for key pairs stored in HashiCorp Vault.

##### Encryptors

- [jnacl](https://github.com/ConsenSys/tessera/tree/master/encryption/encryption-jnacl): (already included in Tessera and remote enclave server distributions)
Adds support for NaCl key pairs using the [jnacl](https://github.com/neilalexander/jnacl) library.
- [Elliptical Curve](https://github.com/ConsenSys/tessera/tree/master/encryption/encryption-ec): Adds support for elliptic curve key pairs.
- [kalium](https://github.com/ConsenSys/tessera/tree/master/encryption/encryption-kalium): Adds support for NaCl key pairs using the [kalium](https://github.com/abstractj/kalium) library.