Skip to content

Updated domains in docs/ and README.md #188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bbengfort merged 1 commit into from
Apr 22, 2025
Merged

Updated domains in docs/ and README.md #188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Go Reference](https://pkg.go.dev/badge/github.com/trisacrypto/trisa/pkg.svg)](https://pkg.go.dev/github.com/trisacrypto/trisa/pkg)
[![Go Report Card](https://goreportcard.com/badge/github.com/trisacrypto/trisa)](https://goreportcard.com/report/github.com/trisacrypto/trisa)

Please visit the [TRISA website](https://trisa.io) for more information and the [TRISA documentation](https://trisatest.net) for developer docs and integration.
Please visit the [TRISA website](https://trisa.io) for more information and the [TRISA documentation](https://testnet.directory) for developer docs and integration.

# Contributing to TRISA

Expand All @@ -31,9 +31,8 @@ The `pkg` folder contains the reference implementation code, including compiled

## The Global Directory Service

Another integral part of the TRISA protocol is the Global Directory Service, which serves as a look-up tool for TRISA members to identify peers with which they wish to exchange information. For RPC definitions and implementation code related to the Global Directory Service, visit the companion [directory repository](https://github.com/trisacrypto/directory). To learn more about how to become a member of the directory, visit [vaspdirectory.net](https://vaspdirectory.net/).
Another integral part of the TRISA protocol is the Global Directory Service, which serves as a look-up tool for TRISA members to identify peers with which they wish to exchange information. For RPC definitions and implementation code related to the Global Directory Service, visit the companion [directory repository](https://github.com/trisacrypto/directory). To learn more about how to become a member of the directory, visit [trisa.directory](https://trisa.directory/).

## Translations

Translations of the documentation on trisa.dev are done periodically by human translators, and may become out-of-sync with the English text or reflect errors. If you notice an error, please open a [bug report](https://github.com/trisacrypto/trisa/issues/new) to notify us.

4 changes: 2 additions & 2 deletions docs/content/api/api.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ The `KeyExchange` RPC allows VASPs to exchange public signing keys to facilitate

### SigningKey

`SigningKey` provides metadata for decoding a PEM encoded PKIX public key for RSA encryption and transaction signing. The SigningKey is a lightweight version of the certificate information stored in the [Directory Service](https://vaspdirectory.net/).
`SigningKey` provides metadata for decoding a PEM encoded PKIX public key for RSA encryption and transaction signing. The SigningKey is a lightweight version of the certificate information stored in the [Directory Service](https://trisa.directory/).

```proto
message SigningKey {
Expand Down Expand Up @@ -179,4 +179,4 @@ type TRISANetworkServer interface {
KeyExchange(context.Context, *SigningKey) (*SigningKey, error)
}
```
For further information, a [reference implementation](https://github.com/trisacrypto/testnet/blob/main/pkg/rvasp/trisa.go) of the TRISA Network protocol is available in Go in the [TRISA TestNet Repository](https://github.com/trisacrypto/testnet),
For further information, a [reference implementation](https://github.com/trisacrypto/testnet/blob/main/pkg/rvasp/trisa.go) of the TRISA Network protocol is available in Go in the [TRISA TestNet Repository](https://github.com/trisacrypto/testnet),
8 changes: 4 additions & 4 deletions docs/content/envoy/configuration.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,13 @@ Configuration values for the public facing TRISA node.

The following configuration influences how the Envoy node connects to the TRISA Global Directory Service.

If you're running a TestNet node, then ensure the values point to `trisatest.net` (e.g. `api.trisatest.net:443`), if you're running a MainNet node, then ensure the values point to `vaspdirectory.net` (the default values).
If you're running a TestNet node, then ensure the values point to `testnet.directory` (e.g. `api.testnet.directory:443`), if you're running a MainNet node, then ensure the values point to `trisa.directory` (the default values).

| EnvVar | Type | Default | Description |
|---|---|---|---|
| TRISA_NODE_DIRECTORY_INSECURE | bool | false | If true, do not connect to the directory using TLS (only useful for local development) |
| TRISA_NODE_DIRECTORY_ENDPOINT | string | api.vaspdirectory.net:443 | The endpoint of the public GDS service |
| TRISA_NODE_DIRECTORY_MEMBERS_ENDPOINT | string | members.vaspdirectory.net:443 | The endpoint of the private members GDS service |
| TRISA_NODE_DIRECTORY_ENDPOINT | string | api.trisa.directory:443 | The endpoint of the public GDS service |
| TRISA_NODE_DIRECTORY_MEMBERS_ENDPOINT | string | members.trisa.directory:443 | The endpoint of the private members GDS service |
| TRISA_DIRECTORY_SYNC_ENABLED | bool | true | If false, then the background directory sync service will not run |
| TRISA_DIRECTORY_SYNC_INTERVAL | duration | 6h | The interval that the node will synchronize counterparties with the GDS |

Expand All @@ -104,4 +104,4 @@ Envoy nodes support some provenance features when deployed in a geographically r
| REGION_INFO_NAME | string | | the name of the region |
| REGION_INFO_COUNTRY | string | | the alpha-2 country code of the region |
| REGION_INFO_CLOUD | string | | the cloud service provider |
| REGION_INFO_CLUSTER | string | | the name of the cluster the node is hosted in |
| REGION_INFO_CLUSTER | string | | the name of the cluster the node is hosted in |
3 changes: 1 addition & 2 deletions docs/content/envoy/deploy.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "A quick guide on deploying your Envoy node"
weight: 10
---

This guide assumes that you're ready to deploy your Envoy node and that you've already obtained either TRISA TestNet or MainNet certificates as described by [the Joining TRISA guide]({{% ref "joining-trisa" %}}). If you haven't already, please go to the [TRISA Global Directory Service (vaspdirectory.net)](https://vaspdirectory.net/) to register for your certificates!
This guide assumes that you're ready to deploy your Envoy node and that you've already obtained either TRISA TestNet or MainNet certificates as described by [the Joining TRISA guide]({{% ref "joining-trisa" %}}). If you haven't already, please go to the [TRISA Global Directory Service (trisa.directory)](https://trisa.directory/) to register for your certificates!

{{% notice style="note" title="Local Development" icon="code" %}}
If you'd like information about how to run Envoy locally using [Docker Compose](https://docs.docker.com/compose/) and self-signed keys generated using `openssl` please go to the repository at [trisacrypto/envoy](https://github.com/trisacrypto/envoy) and follow the instructions in the `README.md`.
Expand Down Expand Up @@ -136,4 +136,3 @@ $ envoy createapikey users:manage users:view
```

The list of the permissions you can add to an API key can be found in the [API guide permissions table]({{% relref "api.en.md#permissions" %}}).

8 changes: 4 additions & 4 deletions docs/content/gds/_index.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,17 @@ This documentation describes the TRISA implementation of the directory service a

## Networks

TRISA currently operates two directory services: a TestNet (trisatest.net) and the MainNet (vaspdirectory.net). The [TestNet]({{% ref "/testing" %}}) is intended to facilitate development and integration and should not be used for actual compliance exchanges. The MainNet is separated from the TestNet with a completely different certificate authority, and certificates issued to TestNet nodes cannot be used to connect to MainNet nodes and vice-versa.
TRISA currently operates two directory services: a TestNet (testnet.directory) and the MainNet (trisa.directory). The [TestNet]({{% ref "/testing" %}}) is intended to facilitate development and integration and should not be used for actual compliance exchanges. The MainNet is separated from the TestNet with a completely different certificate authority, and certificates issued to TestNet nodes cannot be used to connect to MainNet nodes and vice-versa.

Connect to the GDS and register for certificates with the following endpoints/urls:

| Directory | Network | Website | gRPC Endpoint |
|-------------------|---------|---------------------------|-----------------------------|
| trisatest.net | TestNet | https://trisatest.net | `api.trisatest.net:443` |
| vaspdirectory.net | MainNet | https://vaspdirectory.net | `api.vaspdirectory.net:443` |
| testnet.directory | TestNet | https://testnet.directory | `api.testnet.directory:443` |
| trisa.directory | MainNet | https://trisa.directory | `api.trisa.directory:443` |

## Registered Directories

TRISA supports the idea of different directory services that can interoperate by exchanging VASP records with each other. A directory service by definition is a system that has an intermediate certificate authority under one of the TRISA root authority networks (e.g. TestNet or MainNet) and can issue leaf certificates via the intermediate authority. Directory services exchange records with each other to facilitate lookups.

Currently the only registered directories are the TRISA hosted directory services.
Currently the only registered directories are the TRISA hosted directory services.
4 changes: 2 additions & 2 deletions docs/content/gds/admin/_index.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ This section of the documentation is specifically focused on the workflows for T

Each network is controlled by a single GDS, which defines the peers in the network and allocates certificate authority resources (e.g. right now we have a MainNet and a TestNet that are defined by two independent GDS systems). Each GDS is managed by an administrative UI to allow TRISA admins to manage the members in the network.

Access to the Admin UI is limited to TRISA administrators; it is not accessible to the general public or members of the TRISA network. If you wish to view the public-facing landing page for the TRISA Global Directory Service, please visit vaspdirectory.net. If you require support accessing your TRISA administrator account to the Admin UI, please contact [support@rotational.io](mailto:support@rotational.io).
Access to the Admin UI is limited to TRISA administrators; it is not accessible to the general public or members of the TRISA network. If you wish to view the public-facing landing page for the TRISA Global Directory Service, please visit trisa.directory. If you require support accessing your TRISA administrator account to the Admin UI, please contact [support@rotational.io](mailto:support@rotational.io).

This documentation will be expanded in the future to include common workflows and describe the vetting process and requirements for administration via the Admin UI.
This documentation will be expanded in the future to include common workflows and describe the vetting process and requirements for administration via the Admin UI.
8 changes: 4 additions & 4 deletions docs/content/gds/admin/configuration/bff.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
title: "BFF"
date: 2022-12-22T11:52:54-06:00
lastmod: 2022-12-22T11:52:54-06:00
description: "Configuring the BFF for vaspdirectory.net"
description: "Configuring the BFF for trisa.directory"
weight: 20
---

The BFF (backend for frontend) is the backend API that powers the GDS UI at [vaspdirectory.net](https://vaspdirectory.net). The GDS UI is intended to give users a single access portal to both the MainNet and TestNet as well as to support non-GDS features like collaborators and TRISA Service Providers. Because of this it sits in the middle of multiple services, including both the MainNet and TestNet GDS services and multiple data sources. Its environment variables are all prefixed with the `GDS_BFF_` tag. The primary configuration is as follows:
The BFF (backend for frontend) is the backend API that powers the GDS UI at [trisa.directory](https://trisa.directory). The GDS UI is intended to give users a single access portal to both the MainNet and TestNet as well as to support non-GDS features like collaborators and TRISA Service Providers. Because of this it sits in the middle of multiple services, including both the MainNet and TestNet GDS services and multiple data sources. Its environment variables are all prefixed with the `GDS_BFF_` tag. The primary configuration is as follows:

| EnvVar | Type | Default | Description |
|-----------------------|----------|-----------------------|------------------------------------------------------------------------------------------------------------------|
Expand Down Expand Up @@ -148,7 +148,7 @@ The BFF uses [SendGrid](https://sendgrid.com/) to send email notifications and t

| EnvVar | Type | Default | Description |
|-----------------------|--------|---------------------------------------------------|--------------------------------------------------------------------------|
| GDS_BFF_SERVICE_EMAIL | string | TRISA Directory Service <admin@vaspdirectory.net> | The email address used as the sender for all emails from the BFF system. |
| GDS_BFF_SERVICE_EMAIL | string | TRISA Directory Service <admin@trisa.directory> | The email address used as the sender for all emails from the BFF system. |
| SENDGRID_API_KEY | string | | API Key to authenticate to SendGrid with. |
| GDS_BFF_EMAIL_TESTING | bool | false | Use email in testing mode rather than send live emails. |
| GDS_BFF_EMAIL_STORAGE | string | "" | Directory to store test emails for "mark one eyeball" review. |
Expand All @@ -172,4 +172,4 @@ The BFF uses [Sentry](https://sentry.io/) to assist with error monitoring and pe

Sentry is considered **enabled** if a DSN is configured. Performance tracing is only enabled if Sentry is enabled *and* track performance is set to true. If Sentry is enabled, an environment is required, otherwise the configuration will be invalid.

Note that the `sentry.Config` object has a field `Repanic` that should not be set by the user. This field is used to manage panics in chained interceptors.
Note that the `sentry.Config` object has a field `Repanic` that should not be set by the user. This field is used to manage panics in chained interceptors.
Loading
Loading