tlsnotary/docs-mdbook
1
0
Fork 0
mirror of https://github.com/tlsnotary/docs-mdbook.git synced 2026-01-09 12:47:57 -05:00
Code Issues Packages Projects Releases Wiki Activity

Revert browser related pages to v5.

Browse Source
This commit is contained in:
Christopher Chong
2024-06-27 16:14:39 +08:00
committed by Hendrik Eeckhaut
parent 31a11f798e
commit 7940352a12
2 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/quick_start/browser_extension.md
View File

@@ -10,7 +10,7 @@ The easiest way to install the TLSN browser extension is to use **[Chrome Web St
![](images/chromewebstore.png) ![](images/chromewebstore.png)
Alternatively, you can install it manually: Alternatively, you can install it manually:
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> 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 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 ⚠️ 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/> 3. Open **Manage Extensions**: <chrome://extensions/>
@@ -51,7 +51,7 @@ To create a TLSNotary proof, the browser extension needs a TLSNotary notary serv
To use the TLSNotary team notary server: To use the TLSNotary team notary server:
1. Open the extension 1. Open the extension
2. Click **Options** 2. Click **Options**
3. Update Notary API to: `https://notary.pse.dev/v0.1.0-alpha.6` 3. Update Notary API to: `https://notary.pse.dev/v0.1.0-alpha.5`
4. Click **Save** 4. Click **Save**
5. Skip the next section and [continue with the notarization step](#notarize) 5. Skip the next section and [continue with the notarization step](#notarize)
@@ -68,9 +68,9 @@ If you plan to run a local notary server:
1. Clone the TLSNotary repository (defaults to the `main` branch, which points to the latest release): 1. Clone the TLSNotary repository (defaults to the `main` branch, which points to the latest release):
```shell ```shell
git clone https://github.com/tlsnotary/tlsn.git git clone --branch v0.1.0-alpha.5 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. 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 ```yaml
tls: tls:
enabled: false enabled: false
@@ -78,7 +78,7 @@ If you plan to run a local notary server:
``` ```
3. Run the notary server: 3. Run the notary server:
```shell ```shell
cd notary/server cd notary-server
cargo run --release cargo run --release
``` ```

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

@@ -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. 1. Open `app.tsx` in your favorite editor.
2. Replace `notaryUrl: 'http://localhost:7047',` with: 2. Replace `notaryUrl: 'http://localhost:7047',` with:
```ts ```ts
notaryUrl: 'https://notary.pse.dev/v0.1.0-alpha.6', 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. 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: 3. Replace `websocketProxyUrl: 'ws://localhost:55688',` with:
@@ -38,7 +38,7 @@ In this demo, we will request JSON data from the Star Wars API at <https://swapi
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. 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`: check the version number: 4. In `package.json`: check the version number:
```json ```json
"tlsn-js": "v0.1.0-alpha.6.0" "tlsn-js": "v0.1.0-alpha.5.0"
``` ```
5. Install dependencies 5. Install dependencies
```sh ```sh
@@ -76,16 +76,16 @@ For this demo, we also need to run a local notary server.
1. Clone the TLSNotary repository (defaults to the `main` branch, which points to the latest release): 1. Clone the TLSNotary repository (defaults to the `main` branch, which points to the latest release):
```sh ```sh
git clone https://github.com/tlsnotary/tlsn.git git clone --branch v0.1.0-alpha.5 https://github.com/tlsnotary/tlsn.git
``` ```
2. Edit the notary server config file (`notary/server/config/config.yaml`) to turn off TLS so that self-signed certificates can be avoided. 2. Edit the notary server config file (`notary-server/config/config.yaml`) to turn off TLS so that self-signed certificates can be avoided.
```yaml ```yaml
tls: tls:
enabled: false enabled: false
``` ```
3. Run the notary server: 3. Run the notary server:
```sh ```sh
cd notary/server cd notary-server
cargo run --release cargo run --release
``` ```