tlsnotary/docs-mdbook
1
0
Fork 0
mirror of https://github.com/tlsnotary/docs-mdbook.git synced 2026-01-08 20:28:02 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update values.

Browse Source
This commit is contained in:
Christopher Chong
2024-06-26 16:23:40 +08:00
committed by Hendrik Eeckhaut
parent 96fd72d3c4
commit d26b2f7bef
3 changed files with 16 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/developers/notary_server.md
View File

@@ -34,7 +34,7 @@ source ~/.cargo/env
mkdir ~/src; cd ~/src
git clone https://github.com/tlsnotary/tlsn.git
```
4. Switch to your desired [released version](https://github.com/tlsnotary/tlsn/releases), or stay in the `dev` branch to use the latest code (⚠️ only prover of the same version is supported for now)
4. Switch to your desired [released version](https://github.com/tlsnotary/tlsn/releases), or stay in the `main` branch to use the latest version (⚠️ only prover of the same version is supported for now)
```bash
git checkout tags/<version>
```

6
src/quick_start/browser_extension.md
View File

@@ -5,7 +5,7 @@ First we need to [install](#install) and configure a [websocket proxy](#proxy) a
## Install Browser Extension (Chrome/Brave) <a name="install"></a>
1. Download the browser extension from <https://github.com/tlsnotary/tlsn-extension/releases/download/0.1.0.5/tlsn-extension-0.1.0.5.zip>
1. Download the browser extension from <https://github.com/tlsnotary/tlsn-extension/releases/download/0.1.0.6/tlsn-extension-0.1.0.6.zip>
2. Unzip
⚠️ This is a flat zip file, so be careful if you unzip from the command line, this zip file contains many file at the top level
3. Open **Manage Extensions**: <chrome://extensions/>
@@ -65,13 +65,13 @@ If you plan to run a local notary server:
```shell
git clone https://github.com/tlsnotary/tlsn.git
```
3. Edit the notary server config file (`notary/server/config/config.yaml`) to turn off TLS so that the browser extension can connect to the local notary server without requiring extra steps to accept self-signed certificates in the browser.
2. Edit the notary server config file (`notary/server/config/config.yaml`) to turn off TLS so that the browser extension can connect to the local notary server without requiring extra steps to accept self-signed certificates in the browser.
```yaml
tls:
enabled: false
...
```
4. Run the notary server:
3. Run the notary server:
```shell
cd notary/server
cargo run --release

17
src/quick_start/rust.md
View File

@@ -130,10 +130,17 @@ We will also use an explicit (locally hosted) notary server this time.
The notary server used in this example is more functional compared to the (implicit) simple notary service used in the example above. This notary server should actually be run by the Verifier or a neutral party. To make things simple, we run everything on the same machine.
```shell
cd notary/server
cargo run --release
```
1. Edit the notary server config file (`notary/server/config/config.yaml`) to turn off TLS so that the rust prover can connect to the local notary server without requiring extra steps to whitelist self-signed certificates in the code.
```yaml
tls:
enabled: false
...
```
2. Run the notary server:
```shell
cd notary/server
cargo run --release
```
The notary server will now be running in the background waiting for connections.
@@ -191,7 +198,7 @@ The Notary server should log:
2023-11-03T15:53:51.147074Z INFO tokio-runtime-worker ThreadId(10) notary_server::service::tcp: Successful notarization using tcp! session_id="006b3293-8fba-44ac-8692-41daa47e4a9a"
```
If the transcript was too long, you may encounter the following error. This occurs because there is a default limit of notarization size to 16kB:
If the transcript was too long, you may encounter the following error. This occurs because there is a default limit of notarization size to 20KB:
```log
thread 'tokio-runtime-worker' panicked at 'called `Result::unwrap()` on an `Err` value: IOError(Custom { kind: InvalidData, error: BackendError(DecryptionError("Other: KOSReceiverActor is not setup")) })', /Users/heeckhau/tlsnotary/tlsn/tlsn/tlsn-prover/src/lib.rs:173:50