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

Update links for notary server and examples in doc (#72)

Browse Source 
* Switch notary server openapi link for better UI.

* Switch links with dev branch to main branch.
This commit is contained in:
Christopher Chong
2024-03-27 10:51:51 +03:00
committed by GitHub
parent 708da7010b
commit 9cbbd50933
2 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/developers/notary_server.md
View File

@@ -1,9 +1,9 @@
# Run a Notary Server # Run a Notary Server
This guide shows you how to run a [notary server](https://github.com/tlsnotary/tlsn/tree/dev/notary-server) in an Ubuntu server instance. This guide shows you how to run a [notary server](https://github.com/tlsnotary/tlsn/tree/main/notary-server) in an Ubuntu server instance.
## Configure Server Setting ## Configure Server Setting
All the following settings can be configured in the [config file](https://github.com/tlsnotary/tlsn/blob/dev/notary-server/config/config.yaml). All the following settings can be configured in the [config file](https://github.com/tlsnotary/tlsn/blob/main/notary-server/config/config.yaml).
1. Before running a notary server you need the following files. The default dummy fixtures are for testing only and should never be used in production. 1. Before running a notary server you need the following files. The default dummy fixtures are for testing only and should never be used in production.
@@ -14,7 +14,7 @@ All the following settings can be configured in the [config file](https://github
| Notary signature private key | The private key used for the notary server's signature on the generated transcript of the TLS sessions with provers | A P256 elliptic curve private key in PKCS#8 PEM format | Yes | `openssl genpkey -algorithm EC -out eckey.pem -pkeyopt ec_paramgen_curve:P-256 -pkeyopt ec_param_enc:named_curve` | | Notary signature private key | The private key used for the notary server's signature on the generated transcript of the TLS sessions with provers | A P256 elliptic curve private key in PKCS#8 PEM format | Yes | `openssl genpkey -algorithm EC -out eckey.pem -pkeyopt ec_paramgen_curve:P-256 -pkeyopt ec_param_enc:named_curve` |
| Notary signature public key | The public key used for the notary server's signature on the generated transcript of the TLS sessions with provers | A matching public key in PEM format | Yes | `openssl ec -in eckey.pem -pubout -out eckey.pub` | | Notary signature public key | The public key used for the notary server's signature on the generated transcript of the TLS sessions with provers | A matching public key in PEM format | Yes | `openssl ec -in eckey.pem -pubout -out eckey.pub` |
2. Expose the notary server port (specified in the config file) on your server networking setting 2. Expose the notary server port (specified in the config file) on your server networking setting
3. Optionally one can turn on [authorization](https://github.com/tlsnotary/tlsn/tree/dev/notary-server#authorization), or turn off [TLS](https://github.com/tlsnotary/tlsn/tree/dev/notary-server#optional-tls) if TLS is handled by an external setup, e.g. reverse proxy, cloud setup 3. Optionally one can turn on [authorization](https://github.com/tlsnotary/tlsn/tree/main/notary-server#authorization), or turn off [TLS](https://github.com/tlsnotary/tlsn/tree/main/notary-server#optional-tls) if TLS is handled by an external setup, e.g. reverse proxy, cloud setup
## Using Cargo ## Using Cargo
@@ -38,7 +38,7 @@ source ~/.cargo/env
```bash ```bash
git checkout tags/<version> git checkout tags/<version>
``` ```
5. To configure the [server setting](#configure-server-setting), please refer to the `Using Cargo` section in the repo's [readme](https://github.com/tlsnotary/tlsn/blob/dev/notary-server/README.md#using-cargo) 5. To configure the [server setting](#configure-server-setting), please refer to the `Using Cargo` section in the repo's [readme](https://github.com/tlsnotary/tlsn/blob/main/notary-server/README.md#using-cargo)
6. Run the server 6. Run the server
```bash ```bash
cd tlsn/notary-server cd tlsn/notary-server
@@ -48,11 +48,11 @@ cargo run --release
## Using Docker ## Using Docker
1. Install docker following your preferred method [here](https://docs.docker.com/engine/install/ubuntu/) 1. Install docker following your preferred method [here](https://docs.docker.com/engine/install/ubuntu/)
2. To configure the [server setting](#configure-server-setting), please refer to the `Using Docker` section in the repo's [readme](https://github.com/tlsnotary/tlsn/blob/dev/notary-server/README.md#using-docker) 2. To configure the [server setting](#configure-server-setting), please refer to the `Using Docker` section in the repo's [readme](https://github.com/tlsnotary/tlsn/blob/main/notary-server/README.md#using-docker)
3. Run the notary server docker image of your desired version (⚠️ only prover of the same version is supported for now) 3. Run the notary server docker image of your desired version (⚠️ only prover of the same version is supported for now)
```bash ```bash
docker run --init -p 127.0.0.1:7047:7047 ghcr.io/tlsnotary/tlsn/notary-server:<version> docker run --init -p 127.0.0.1:7047:7047 ghcr.io/tlsnotary/tlsn/notary-server:<version>
``` ```
## API Endpoints ## API Endpoints
Please refer to the list of all API endpoints [here](https://github.com/tlsnotary/tlsn/tree/dev/notary-server#api). Please refer to the list of all API endpoints [here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/tlsnotary/tlsn/main/notary-server/openapi.yaml#/).

2
src/quick_start/rust.md
View File

@@ -216,7 +216,7 @@ cargo run --release --example discord_dm_verifier
If the examples above were too easy for you, try to notarize data from other websites such as: If the examples above were too easy for you, try to notarize data from other websites such as:
- [ ] Amazon purchase - [ ] Amazon purchase
- [ ] Twitter DM (see <https://github.com/tlsnotary/tlsn/blob/dev/tlsn/examples/twitter/README.md>) - [ ] Twitter DM (see <https://github.com/tlsnotary/tlsn/blob/main/tlsn/examples/twitter/README.md>)
- [ ] LinkedIn skill - [ ] LinkedIn skill
- [ ] Steam accomplishment - [ ] Steam accomplishment
- [ ] Garmin Connect achievement - [ ] Garmin Connect achievement