Update broken links & simplify Getting Started pages (#39)

* Update Unbound repo link * Fix broken libsodium links and simplify dependencies, installation, and quickstart pages
Consensys · Dec 8, 2020 · 0059438 · 0059438
1 parent 414b0e6
commit 0059438
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 42 deletions.
diff --git a/docs/HowTo/Configure/Tessera.md b/docs/HowTo/Configure/Tessera.md
@@ -64,8 +64,7 @@ Field|Default Value|Description
 `sharedKeyLength`|`32`|The key length used for symmetric encryption (keep in mind the key derivation operation always produces 32 byte keys and that the encryption algorithm must support it).
 
 If `type` is set to `CUSTOM`, it provides support for external encryptor implementation to integrate
-with Tessera. Our pilot third party integration is with **Unbound Tech's "Unbound Key Control" (UKC)**
-implementation. For more information refer to [UKC site](https://github.com/unbound-tech/encryption-ub)
+with Tessera. The pilot third party integration is [Unbound Tech's Unbound Key Control (UKC) encryptor](https://github.com/unbound-tech/ub-integration/tree/master/Tessera) (jar available at `com.github.unbound-tech:encryption-ub:<version>`).
 
 ### Always-send-to
 

diff --git a/docs/HowTo/Get-started/Dependencies.md b/docs/HowTo/Get-started/Dependencies.md
@@ -4,38 +4,16 @@ description: Tessera dependencies
 
 # Dependencies
 
-## libsodium
+## Java JDK
 
-If using the [kalium](https://github.com/abstractj/kalium) NaCI cryptography implementation, Tessera
-requires the [Sodium cryptographic library](https://download.libsodium.org/doc/) (libsodium) to provide the encryption primitives.
+Tessera requires [Java JDK 11+](http://www.oracle.com/technetwork/java/javase/downloads/index.html). Earlier versions are not supported.
 
-!!! tip
-    If using the default NaCI cryptography implementation, [jnacl](https://github.com/neilalexander/jnacl),
-    [libsodium](https://download.libsodium.org/doc/) is not required.
+## libsodium (optional)
 
-### Install libsodium
+[libsodium (the Sodium cryptographic library)](https://libsodium.gitbook.io/doc/)) must be installed if using [kalium](https://github.com/abstractj/kalium) instead of the default [jnacl](https://github.com/neilalexander/jnacl) NaCl implementation.
 
-#### macOS
-
-Install using [Homebrew](https://brew.sh/):
+See the [libsodium installation docs](https://libsodium.gitbook.io/doc/) or install using [brew](https://brew.sh/) (macOS only):
 
 ```bash
 brew install libsodium
 ```
-
-#### Linux
-
-Download the [latest stable version](https://download.libsodium.org/libsodium/releases/LATEST.tar.gz)
-of libsodium.
-
-Execute:
-
-```bash
-./configure
-make && make check
-sudo make install
-```
-
-#### Other systems
-
-See the [libsodium installation docs](https://download.libsodium.org/doc/installation/).
diff --git a/docs/HowTo/Get-started/DistributionJar.md b/docs/HowTo/Get-started/DistributionJar.md
@@ -4,26 +4,43 @@ description: Install Tessera from jar
 
 # Install Tessera jar
 
-## Prerequisites
+1. Install necessary [dependencies](Dependencies.md)
 
-* [Java JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html). Tessera requires Java
-JDK 11+. Earlier versions are not supported.
-* [libsodium](https://download.libsodium.org/doc/), if using the [kalium](https://github.com/abstractj/kalium)
-NaCI cryptography implementation.
+1. Download the latest `tessera-app-<VERSION>-app.jar` from [`ConsenSys/tessera` repository](https://github.com/ConsenSys/tessera/releases/latest)
 
-## Install jar
-
-1. Download the [`tessera-app-VERSION-app.jar`](https://github.com/ConsenSys/tessera/releases/latest)
-from the `ConsenSys/tessera` repository. `VERSION` is the version of the latest release.
-
-2. Create an alias to the Tessera jar.
+1. (Optional) Create an alias
 
     ```bash
     alias tessera="java -jar ~/Downloads/tessera-VERSION-app.jar"
     ```
 
-3. Display the Tessera help to confirm installation.
+1. Verify installation.
 
     ```bash
     tessera --help
+
+      Usage:
+
+      Tessera private transaction manager for Quorum
+
+      tessera [OPTIONS] [COMMAND]
+
+      Description:
+
+      Start a Tessera node.  Other commands exist to manage Tessera encryption keys
+
+      Options:
+      -configfile, --configfile <config>
+      Path to node configuration file
+      --debug                Print full exception stack traces
+      -o, --override KEY=VALUE
+      -pidfile, --pidfile <pidFilePath>
+      the path to write the PID to
+      -r, --recover              Start Tessera in recovery mode
+
+      Commands:
+      help                        Displays help information about the specified
+      command
+      keygen, -keygen             Generate Tessera encryption keys
+      keyupdate, -updatepassword  Update the password for a key
     ```
diff --git a/docs/HowTo/Get-started/Start-Tessera.md b/docs/HowTo/Get-started/Start-Tessera.md
@@ -6,7 +6,9 @@ description: Get started with Tessera and send a payload
 
 ## Prerequisites
 
-[Tessera](DistributionJar.md)
+1. Install necessary [dependencies](Dependencies.md)
+
+1. Install [Tessera](DistributionJar.md)
 
 ## Starting Tessera and sending a payload