Skip to content

Commit

Permalink
Docker and azure updates (#95)
Browse files Browse the repository at this point in the history
* Add Docker page to Getting Started section

* Update Azure configuration documentation for the latest version of Tessera which replaces deprecated Azure client library

* Fix vale lint error

* Update link to jasypt docs as www.jasypt.org is unavailable

* Update link to jasypt docs as www.jasypt.org is unavailable
  • Loading branch information
chris-j-h authored Jul 12, 2021
1 parent 74db546 commit 1aa1c52
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/HowTo/Configure/Database.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Any valid JDBC URL may be specified, refer to your providers details to construc

Certain entries in the Tessera configuration file must be obfuscated to prevent any attempts from
attackers to gain access to critical parts of the application (for example the database).
The database password can be encrypted using [Jasypt](http://www.jasypt.org) to avoid it being
The database password can be encrypted using [Jasypt](https://github.com/jasypt/jasypt) to avoid it being
exposed as plain text in the configuration file.

To enable this feature, simply replace your plain-text database password with its encrypted value
Expand Down Expand Up @@ -47,7 +47,7 @@ password however this approach is not recommended for production environments.

### How to encrypt database password

1. Download and unzip [Jasypt](http://www.jasypt.org) and redirect to the `bin` directory
1. Download and unzip [Jasypt](https://github.com/jasypt/jasypt) and redirect to the `bin` directory
1. Encrypt the password

=== "Command"
Expand Down
5 changes: 3 additions & 2 deletions docs/HowTo/Configure/KeyVault/Azure-Key-Vault.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,13 @@ To authorise the newly registered app to use the Key Vault complete the followin
### Environment Variables
If using an Azure Key Vault, Tessera requires two environment variables to be set:
If using an Azure Key Vault, Tessera requires three environment variables to be set:
1. `AZURE_CLIENT_ID`: The `Application ID`
1. `AZURE_CLIENT_SECRET`: The application registration `key`
1. `AZURE_TENANT_ID`: The Azure Active Directory `Tenant ID`
Both of these values can be retrieved during the application registration process as outlined above.
Each of these values can be retrieved during the application registration process as outlined above.
### Dependencies
Expand Down
23 changes: 23 additions & 0 deletions docs/HowTo/Get-started/Docker-Images.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
description: Use Tessera Docker images
---

# Docker images

Docker images are available at [quorumengineering/tessera](https://hub.docker.com/r/quorumengineering/tessera).

Various images are available (Tessera, Tessera with additional key vault support, etc.). See Tessera's [Docker README](https://github.com/ConsenSys/tessera/blob/master/docker/README.md) for more information.

## Usage

Pull an image:

```shell
docker pull quorumengineering/tessera:latest # pull latest release version
```

Verify image:

```shell
docker run quorumengineering/tessera:latest help
```
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ nav:
- Get started with Tessera:
- Dependencies: HowTo/Get-started/Dependencies.md
- Install distribution: HowTo/Get-started/Distribution.md
- Docker images: HowTo/Get-started/Docker-Images.md
- Build from source: HowTo/Get-started/Build-From-Source.md
- Start Tessera: HowTo/Get-started/Start-Tessera.md
- Generate keys:
Expand Down

0 comments on commit 1aa1c52

Please sign in to comment.