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

WIP: preparing for alpha5 release (#78)

Browse Source 
updates for alpha5 release

* updated quickstart
* explicit version in notary server url
* Added alpha5 to notary urls

Co-authored-by: Christopher Chong <t.kleinchong@gmail.com>
This commit is contained in:
Hendrik Eeckhaut
2024-04-10 09:17:19 +02:00
committed by GitHub
parent 1c2d7b078b
commit 6cdc2e5d9d
4 changed files with 14 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/developers/notary_server.md
View File

@@ -67,7 +67,8 @@ We host multiple versions of the notary server:
| Version | Notary URL | Info/Status | GitHub | Note |
|---------------|---------------------------------------|----------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|-----------------------------------------------|
| latest | https://notary.pse.dev | [info](https://notary.pse.dev/info)/[health](https://notary.pse.dev/healthcheck) | [main](https://github.com/tlsnotary/tlsn/tree/main/notary-server) | Currently the same as v0.1.0-alpha.4 |
| v0.1.0-alpha.5 | https://notary.pse.dev/v0.1.0-alpha.5 | [info](https://notary.pse.dev/v0.1.0-alpha.5/info)/[health](https://notary.pse.dev/v0.1.0-alpha.5/healthcheck) | [v0.1.0-alpha.5](https://github.com/tlsnotary/tlsn/tree/v0.1.0-alpha.5/notary-server) | [Release notes](https://github.com/tlsnotary/tlsn/releases/tag/v0.1.0-alpha.5) |
| (deprecated) | https://notary.pse.dev | [info](https://notary.pse.dev/info)/[health](https://notary.pse.dev/healthcheck) | [v0.1.0-alpha.4](https://github.com/tlsnotary/tlsn/tree/v0.1.0-alpha.4/notary-server) | This url will be removed when alpha.6 is released |
| v0.1.0-alpha.4 | https://notary.pse.dev/v0.1.0-alpha.4 | [info](https://notary.pse.dev/v0.1.0-alpha.4/info)/[health](https://notary.pse.dev/v0.1.0-alpha.4/healthcheck) | [v0.1.0-alpha.4](https://github.com/tlsnotary/tlsn/tree/v0.1.0-alpha.4/notary-server) | [Release notes](https://github.com/tlsnotary/tlsn/releases/tag/v0.1.0-alpha.4) |
| v0.1.0-alpha.3 | https://notary.pse.dev/v0.1.0-alpha.3 | [info](https://notary.pse.dev/v0.1.0-alpha.3/info)/[health](https://notary.pse.dev/v0.1.0-alpha.3/healthcheck) | [v0.1.0-alpha.3](https://github.com/tlsnotary/tlsn/tree/v0.1.0-alpha.3/notary-server) | [Release notes](https://github.com/tlsnotary/tlsn/releases/tag/v0.1.0-alpha.3) |
| nightly | https://notary.pse.dev/nightly | [info](https://notary.pse.dev/nightly/info)/[health](https://notary.pse.dev/nightly/healthcheck) | [dev](https://github.com/tlsnotary/tlsn/tree/dev/notary-server) | |

8
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.4/tlsn-extension-0.1.0.4.zip>
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>
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/>
@@ -46,7 +46,7 @@ To create a TLSNotary proof, the browser extension needs a TLSNotary notary serv
To use the TLSNotary team notary server:
1. Open the extension
2. Click **Options**
3. Update Notary API to: `https://notary.pse.dev`
3. Update Notary API to: `https://notary.pse.dev/v0.1.0-alpha.5`
4. Click **Save**
5. Skip the next section and [continue with the notarization step](#notarize)
@@ -61,9 +61,9 @@ If you plan to run a local notary server:
### Run a Local Notary Server <a name="local-notary"></a>
1. Clone the TLSNotary repository ("v0.1.0-alpha.4"):
1. Clone the TLSNotary repository (defaults to the `main` branch, which points to the latest release):
```shell
git clone https://github.com/tlsnotary/tlsn.git --branch "v0.1.0-alpha.4"
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.
```yaml

4
src/quick_start/rust.md
View File

@@ -8,10 +8,10 @@ Before we start, make sure you have cloned the `tlsn` repository and have a rece
### Clone the TLSNotary Repository
Clone the `tlsn` repository:
Clone the `tlsn` repository (defaults to the `main` branch, which points to the latest release):
```shell
git clone https://github.com/tlsnotary/tlsn.git --branch "v0.1.0-alpha.4"
git clone https://github.com/tlsnotary/tlsn.git"
```
Next open the `tlsn` folder in your favorite IDE.

12
src/quick_start/tlsn-js.md
View File

@@ -1,6 +1,6 @@
# TLSNotary in React/Typescript with `tlsn-js`<a name="browser"></a>
In this Quick Start you will learn how to use TLSNotary in React/Typescript with [`tlsn-js`](https://github.com/tlsnotary/) NPM module in the browser.
In this Quick Start you will learn how to use TLSNotary in React/Typescript with [`tlsn-js`](https://github.com/tlsnotary/tlsn-js) NPM module in the browser.
This Quick Start uses the react/typescript [demo app in `tlsn-js`](https://github.com/tlsnotary/tlsn-js/tree/main/demo/react-ts-webpack). The directory contains a webpack configuration file that allows you to quickly bootstrap a webpack app using `tlsn-js`.
@@ -28,7 +28,7 @@ In this demo, we will request JSON data from the Star Wars API at <https://swapi
1. Open `app.tsx` in your favorite editor.
2. Replace `notaryUrl: 'http://localhost:7047',` with:
```ts
notaryUrl: 'https://notary.pse.dev',
notaryUrl: 'https://notary.pse.dev/v0.1.0-alpha.5',
```
This makes this webpage use the [PSE](https://pse.dev) notary server to notarize the API request. Feel free to use different or [local notary](#local); a local server will be faster because it removes the bandwidth constraints between the user and the notary.
3. Replace `websocketProxyUrl: 'ws://localhost:55688',` with:
@@ -36,9 +36,9 @@ In this demo, we will request JSON data from the Star Wars API at <https://swapi
websocketProxyUrl: 'wss://notary.pse.dev/proxy?token=swapi.dev',
```
Because a web browser doesn't have the ability to make TCP connection, we need to use a websocket proxy server. This uses a proxy hosted by [PSE](https://pse.dev). Feel free to use different or [local notary](#local) proxy.
4. In `package.json`: replace `"tlsn-js": "../../../tlsn-js"` with:
4. In `package.json`: check the version number:
```json
"tlsn-js": "v0.1.0-alpha.4"
"tlsn-js": "v0.1.0-alpha.5.0"
```
5. Install dependencies
```sh
@@ -74,9 +74,9 @@ Note the `swapi.dev:443` argument on the last line, this is the server we will u
For this demo, we also need to run a local notary server.
1. Clone the TLSNotary repository:
1. Clone the TLSNotary repository (defaults to the `main` branch, which points to the latest release):
```sh
git clone https://github.com/tlsnotary/tlsn.git --branch "v0.1.0-alpha.4"
git clone https://github.com/tlsnotary/tlsn.git
```
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