github/tlsn-js
1
1
Fork 0
mirror of https://github.com/tlsnotary/tlsn-js.git synced 2026-04-02 03:00:18 -04:00
Code Issues Packages Projects Releases Wiki Activity

doc: Fix quickstart to work with notary server alpha.6 (#64)

Browse Source
This commit is contained in:
Hendrik Eeckhaut
2024-08-16 13:45:20 +02:00
committed by GitHub
parent 7b78fbca61
commit 313896a986
1 changed files with 13 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
quickstart.md
View File

@@ -12,11 +12,11 @@ To run your own websocket proxy for `https://swapi.dev` **locally**:
1. Install [websocat](https://github.com/vi/websocat):
| tool | command |
|--------|-------------------------------|
| cargo | `cargo install websocat` |
| brew | `brew install websocat` |
| source | https://github.com/vi/websocat|
| tool | command |
| ------ | ------------------------------ |
| cargo | `cargo install websocat` |
| brew | `brew install websocat` |
| source | https://github.com/vi/websocat |
2. Run a websocket proxy for `https://swapi.dev`:
```sh
@@ -31,16 +31,16 @@ For this demo, we also need to run a local notary server.
1. Clone the TLSNotary repository:
```shell
git clone https://github.com/tlsnotary/tlsn.git --branch "v0.1.0-alpha.5"
git clone https://github.com/tlsnotary/tlsn.git --branch "v0.1.0-alpha.6"
```
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.
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
```
3. Run the notary server:
```shell
cd notary-server
cd notary/server
cargo run --release
```
@@ -53,6 +53,11 @@ The notary server will now be running in the background waiting for connections.
```sh
git clone https://github.com/tlsnotary/tlsn-js
```
2. Compile tlns-js
```sh
npm i
npm run build
```
2. Go to the demo folder
```sh
cd ./tlsn-js/demo/react-ts-webpack