diff --git a/docs/HowTo/Get-started/Distribution.md b/docs/HowTo/Get-started/Distribution.md index 31705a3..40c309d 100644 --- a/docs/HowTo/Get-started/Distribution.md +++ b/docs/HowTo/Get-started/Distribution.md @@ -4,17 +4,54 @@ description: Install Tessera # Install Tessera -1. Install necessary [dependencies](Dependencies.md) +* Install necessary [dependencies](Dependencies.md) -1. Download and unpack the latest `tessera-app--app.zip|tar` from the +* Download and unpack the latest `tessera-app--app.zip|tar` distribution from the [`ConsenSys/tessera` repository](https://github.com/ConsenSys/tessera/releases/latest) ```shell - tar xvf tessera-dist-[version].tar - ./tessera-dist-[version]/bin/tessera --help - ``` -2. Add tessera script to path (optional but rest of documentation assumes its in the path) +$ tar xvf tessera-[version].tar +$ tree tessera-[version] +tessera-[version] +├── bin +│ ├── tessera +│ └── tessera.bat +└── lib + ├── HikariCP-3.2.0.jar + ... +``` + +* Add tessera script to path (optional but rest of documentation assumes its in the path) ```shell export PATH=$PATH:tessera-dist-[version]/bin ``` + +* Verify the installation with the `help` command. + +```shell +./tessera-dist/build/distributions/tessera-/ help +``` + +## Supplementing the distribution + +Additional functionality can be added to a distribution by adding `.jar` files to the `/lib` directory. + +### Adding Tessera artefacts + +Download and unpack the artefact: + +```shell +$ tar xvf aws-key-vault-[version].tar +$ tree aws-key-vault-[version] +aws-key-vault-[version].tar +└── lib + ├── annotations-2.10.25.jar + ... +``` + +Copy the contents of the artefact's `/lib` into the distribution `/lib` (make sure to resolve any version conflicts/duplicated `.jar` files introduced during the copy): + +```shell + cp -a aws-key-vault-[version]/lib/. tessera-[version]/lib/ +```