Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 9 additions & 9 deletions packages/documentation/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@
"astro": "astro"
},
"dependencies": {
"@astrojs/markdown-remark": "^6.3.2",
"@astrojs/starlight": "^0.34.4",
"@interledger/docs-design-system": "^0.8.0",
"astro": "5.11.0",
"mermaid": "^11.8.1",
"@astrojs/markdown-remark": "^6.3.9",
"@astrojs/starlight": "^0.36.2",
"@interledger/docs-design-system": "^0.10.1",
"astro": "5.16.0",
"mermaid": "^11.12.1",
"rehype-autolink-headings": "^7.1.0",
"rehype-mathjax": "^7.1.0",
"remark-math": "^6.0.0",
"spectaql": "^3.0.4",
"starlight-fullview-mode": "^0.2.3",
"starlight-links-validator": "^0.17.0",
"starlight-versions": "^0.5.5"
"spectaql": "^3.0.5",
"starlight-fullview-mode": "^0.2.6",
"starlight-links-validator": "^0.19.1",
"starlight-versions": "^0.5.6"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,10 @@ Kratos also enhances security with features like built-in breach detection, secu

Ory Kratos provides frontend components (such as forms and buttons) for identity management flows like login, and account settings. These components are not fixed in design; they are fetched via API calls which allows us to match the identity management components with Rafiki Admin's overall look and feel.

:::danger[Disabling authentication]

<KratosWarn />
:::

## Navigation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@ You can deposit and withdraw asset liquidity through the Rafiki Admin applicatio

## Manage asset liquidity using the Backend Admin API

:::note[Idempotency key]

<IdempotencyNote />
:::

### Deposit asset liquidity

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@ For more information about how Rafiki handles liquidity, see the [Accounting](/o

## Manage payment liquidity using the Backend Admin API

:::note[Idempotency key]

<IdempotencyNote />
:::

### Withdraw incoming payment liquidity

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@ You can deposit and withdraw peer liquidity through the Rafiki Admin application

## Manage peer liquidity using the Backend Admin API

:::note[Idempotency key]

<IdempotencyNote />
:::

### Deposit peer liquidity

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@ If the timeout interval passes before the transaction posts or is voided, the tr

## Manage two-phase transfers using the Backend Admin API

:::note[Idempotency key]

<IdempotencyNote />
:::

### Post and commit a successful transfer

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,11 @@ Some of your customers use a third-party application that allows them to create

We strongly encourage you to familiarize yourself with the Open Payments standard. Extensive documentation is available on the <LinkOut href="https://openpayments.dev">Open Payments</LinkOut> website. We recommend you start by reviewing all the pages within the _Intro to Open Payments_ section. Here are a few links to get you started.

- <LinkOut href='https://openpayments.dev/overview/getting-started/'>
Getting started with Open Payments
</LinkOut>
- <LinkOut href='https://openpayments.dev/identity/client-keys/'>
Client keys
</LinkOut>
- <LinkOut href='https://openpayments.dev/identity/http-signatures/'>
HTTP message signatures
</LinkOut>
- <LinkOut href='https://openpayments.dev/identity/grants/'>
Grant negotiation and authorization
</LinkOut>
{/* prettier-ignore */}
- <LinkOut href='https://openpayments.dev/overview/getting-started/'>Getting started with Open Payments</LinkOut>
- <LinkOut href='https://openpayments.dev/identity/client-keys/'>Client keys</LinkOut>
- <LinkOut href='https://openpayments.dev/identity/http-signatures/'>HTTP message signatures</LinkOut>
- <LinkOut href='https://openpayments.dev/identity/grants/'>Grant negotiation and authorization</LinkOut>

## Rafiki's backend service

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,15 +143,10 @@ The following table shows the values in the algorithm when running transactions

Rafiki’s telemetry solution is a combination of techniques described in various white papers on privacy-preserving data collection. More information can be found in the following papers:

- <LinkOut href='https://jwcn-eurasipjournals.springeropen.com/articles/10.1186/s13638-020-01675-8'>
Local differential privacy for human-centered computing
</LinkOut>
- <LinkOut href='https://www.microsoft.com/en-us/research/blog/collecting-telemetry-data-privately/'>
Collecting telemetry data privately
</LinkOut>
- <LinkOut href='https://static.googleusercontent.com/media/research.google.com/en//pubs/archive/42852.pdf'>
RAPPOR: Randomized aggregatable privacy-preserving ordinal response
</LinkOut>
{/* prettier-ignore */}
- <LinkOut href='https://jwcn-eurasipjournals.springeropen.com/articles/10.1186/s13638-020-01675-8'>Local differential privacy for human-centered computing</LinkOut>
- <LinkOut href='https://www.microsoft.com/en-us/research/blog/collecting-telemetry-data-privately/'>Collecting telemetry data privately</LinkOut>
- <LinkOut href='https://static.googleusercontent.com/media/research.google.com/en//pubs/archive/42852.pdf'>RAPPOR: Randomized aggregatable privacy-preserving ordinal response</LinkOut>

## Deploy custom telemetry

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,11 @@ Some of your customers use a third-party application that allows them to create

We strongly encourage you to familiarize yourself with the Open Payments standard. Extensive documentation is available on the <LinkOut href="https://openpayments.dev">Open Payments</LinkOut> website. We recommend you start by reviewing all the pages within the _Intro to Open Payments_ section. Here are a few links to get you started.

- <LinkOut href='https://openpayments.dev/overview/getting-started/'>
Getting started with Open Payments
</LinkOut>
- <LinkOut href='https://openpayments.dev/identity/client-keys/'>
Client keys
</LinkOut>
- <LinkOut href='https://openpayments.dev/identity/http-signatures/'>
HTTP message signatures
</LinkOut>
- <LinkOut href='https://openpayments.dev/identity/grants/'>
Grant negotiation and authorization
</LinkOut>
{/* prettier-ignore */}
- <LinkOut href='https://openpayments.dev/overview/getting-started/'>Getting started with Open Payments</LinkOut>
- <LinkOut href='https://openpayments.dev/identity/client-keys/'>Client keys</LinkOut>
- <LinkOut href='https://openpayments.dev/identity/http-signatures/'>HTTP message signatures</LinkOut>
- <LinkOut href='https://openpayments.dev/identity/grants/'>Grant negotiation and authorization</LinkOut>

## Rafiki's backend service

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,15 +144,10 @@ The following table shows the values in the algorithm when running transactions

Rafiki’s telemetry solution is a combination of techniques described in various white papers on privacy-preserving data collection. More information can be found in the following papers:

- <LinkOut href='https://jwcn-eurasipjournals.springeropen.com/articles/10.1186/s13638-020-01675-8'>
Local differential privacy for human-centered computing
</LinkOut>
- <LinkOut href='https://www.microsoft.com/en-us/research/blog/collecting-telemetry-data-privately/'>
Collecting telemetry data privately
</LinkOut>
- <LinkOut href='https://static.googleusercontent.com/media/research.google.com/en//pubs/archive/42852.pdf'>
RAPPOR: Randomized aggregatable privacy-preserving ordinal response
</LinkOut>
{/* prettier-ignore */}
- <LinkOut href='https://jwcn-eurasipjournals.springeropen.com/articles/10.1186/s13638-020-01675-8'>Local differential privacy for human-centered computing</LinkOut>
- <LinkOut href='https://www.microsoft.com/en-us/research/blog/collecting-telemetry-data-privately/'>Collecting telemetry data privately</LinkOut>
- <LinkOut href='https://static.googleusercontent.com/media/research.google.com/en//pubs/archive/42852.pdf'>RAPPOR: Randomized aggregatable privacy-preserving ordinal response</LinkOut>

## Deploy custom telemetry

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,9 @@ Deploy a general purpose VM with the following minimum specifications:

Install the following software on the VM:

- <LinkOut href='https://docs.docker.com/engine/install/'>
Docker Engine
</LinkOut>
- <LinkOut href='https://docs.docker.com/compose/install/#scenario-two-install-the-compose-plugin'>
Docker Compose
</LinkOut>
{/* prettier-ignore */}
- <LinkOut href='https://docs.docker.com/engine/install/'>Docker Engine</LinkOut>
- <LinkOut href='https://docs.docker.com/compose/install/#scenario-two-install-the-compose-plugin'>Docker Compose</LinkOut>

### Install Nginx and Certbot

Expand Down Expand Up @@ -312,7 +309,10 @@ redis:

The Kratos service is an identity and user management solution used by Rafiki's `frontend` service for handling authentication and user management tasks.

:::danger[Disabling authentication]

<KratosWarn />
:::

```sh
kratos:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,10 @@ The following are required when using the `frontend` service:
- A Rafiki [`backend`](/integration/deployment/services/backend-service) service up and running to access the Backend Admin API.
- An identity provider for authentication and user management. Out of the box, the Rafiki Admin application uses <LinkOut href="https://www.ory.sh/docs/kratos/ory-kratos-intro">Ory Kratos</LinkOut>, a secure and fully open-source identity management solution.

:::danger[Disabling authentication]

<KratosWarn />
:::

You must also set the environment variables for the `frontend` service.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,9 @@ The [Local Playground](/integration/playground/overview/) is not the only way to

The current applications include:

- <LinkOut href='https://wallet.interledger-test.dev/'>
An Interledger test wallet
</LinkOut>
- <LinkOut href='https://boutique.interledger-test.dev/products'>
An e-commerce application
</LinkOut>
{/* prettier-ignore */}
- <LinkOut href='https://wallet.interledger-test.dev/'>An Interledger test wallet</LinkOut>
- <LinkOut href='https://boutique.interledger-test.dev/products'>An e-commerce application</LinkOut>

## Peering with the Test Network

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,9 @@ An asset represents an item of value that can be transferred via the Interledger
```
For more information about this mutation's input object, see [`CreateAssetInput`](/apis/graphql/backend/#definition-CreateAssetInput).

<TenantIdHmacNote />
:::note[Tenant ID and HMAC-signed request headers]
<TenantIdHmacNote />
:::

</TabItem>
<TabItem label="Response">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,9 @@ As mentioned in the prerequisites, you must add an asset to your Rafiki instance
```
For more information about this mutation's input object, see [`CreatePeerInput`](/apis/graphql/backend/#definition-CreatePeerInput).

<TenantIdHmacNote />
:::note[Tenant ID and HMAC-signed request headers]
<TenantIdHmacNote />
:::

</TabItem>
<TabItem label="Response">
Expand Down Expand Up @@ -197,7 +199,9 @@ In this example we will update the peer we just created. Rather than change any
```
For more information about this mutation's input object, see [`UpdatePeerInput`](/apis/graphql/backend/#definition-UpdatePeerInput).

<TenantIdHmacNote />
:::note[Tenant ID and HMAC-signed request headers]
<TenantIdHmacNote />
:::

</TabItem>
<TabItem label="Response">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,10 @@ Ensure your script calls the `createWalletAddress` GraphQL mutation.
```
For more information about this mutation's input object, see [`CreateWalletAddressInput`](/apis/graphql/backend/#definition-CreateWalletAddressInput).

:::note[Tenant ID and HMAC-signed request headers]

<TenantIdHmacNote />
:::

</TabItem>
<TabItem label="Response">
Expand Down Expand Up @@ -116,9 +119,9 @@ Ensure your script calls the `createWalletAddress` GraphQL mutation.
}
```

:::note[Tenant ID in the wallet address response]
The `walletAddress` object in the response will include the `tenantId` of the tenant to which the wallet address belongs. This `tenantId` is used to identify the tenant when processing Open Payments requests.
:::
:::note[Tenant ID in the wallet address response]
The `walletAddress` object in the response will include the `tenantId` of the tenant to which the wallet address belongs. This `tenantId` is used to identify the tenant when processing Open Payments requests.
:::

</TabItem>
</Tabs>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,11 @@ Some of your customers use a third-party application that allows them to create

We strongly encourage you to familiarize yourself with the Open Payments standard. Extensive documentation is available on the <LinkOut href="https://openpayments.dev">Open Payments</LinkOut> website. We recommend you start by reviewing all the pages within the _Intro to Open Payments_ section. Here are a few links to get you started.

- <LinkOut href='https://openpayments.dev/overview/getting-started/'>
Getting started with Open Payments
</LinkOut>
- <LinkOut href='https://openpayments.dev/identity/client-keys/'>
Client keys
</LinkOut>
- <LinkOut href='https://openpayments.dev/identity/http-signatures/'>
HTTP message signatures
</LinkOut>
- <LinkOut href='https://openpayments.dev/identity/grants/'>
Grant negotiation and authorization
</LinkOut>
{/* prettier-ignore */}
- <LinkOut href='https://openpayments.dev/overview/getting-started/'>Getting started with Open Payments</LinkOut>
- <LinkOut href='https://openpayments.dev/identity/client-keys/'>Client keys</LinkOut>
- <LinkOut href='https://openpayments.dev/identity/http-signatures/'>HTTP message signatures</LinkOut>
- <LinkOut href='https://openpayments.dev/identity/grants/'>Grant negotiation and authorization</LinkOut>

## Rafiki's backend service

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,15 +143,10 @@ The following table shows the values in the algorithm when running transactions

Rafiki’s telemetry solution is a combination of techniques described in various white papers on privacy-preserving data collection. More information can be found in the following papers:

- <LinkOut href='https://jwcn-eurasipjournals.springeropen.com/articles/10.1186/s13638-020-01675-8'>
Local differential privacy for human-centered computing
</LinkOut>
- <LinkOut href='https://www.microsoft.com/en-us/research/blog/collecting-telemetry-data-privately/'>
Collecting telemetry data privately
</LinkOut>
- <LinkOut href='https://static.googleusercontent.com/media/research.google.com/en//pubs/archive/42852.pdf'>
RAPPOR: Randomized aggregatable privacy-preserving ordinal response
</LinkOut>
{/* prettier-ignore */}
- <LinkOut href='https://jwcn-eurasipjournals.springeropen.com/articles/10.1186/s13638-020-01675-8'>Local differential privacy for human-centered computing</LinkOut>
- <LinkOut href='https://www.microsoft.com/en-us/research/blog/collecting-telemetry-data-privately/'>Collecting telemetry data privately</LinkOut>
- <LinkOut href='https://static.googleusercontent.com/media/research.google.com/en//pubs/archive/42852.pdf'>RAPPOR: Randomized aggregatable privacy-preserving ordinal response</LinkOut>

## Deploy custom telemetry

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,9 @@ These services rely on a number of databases.
- A Postgres database used by the `auth` service for storing auth-related resources (grants, access tokens, and interactions)
- A Redis database used by the `auth` service to store session data
- A Postgres database used by the `backend` service for Open Payments resources, tenant information, and other application data
- <LinkOut href='https://github.com/tigerbeetle/tigerbeetle'>
TigerBeetle
</LinkOut>
, used by the `backend` service for accounting balances

{/* prettier-ignore */}
- <LinkOut href='https://github.com/tigerbeetle/tigerbeetle'>TigerBeetle</LinkOut>, used by the `backend` service for accounting balances
- A Redis database used by the `backend` service as a cache to share STREAM connection details across processes

An additional package for [token introspection](/integration/deployment/services/auth-service#token-introspection) is also included with Rafiki. This is an internal package that requires no action on your part if you’re using Rafiki’s `auth` service.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@ The environment variable in the preceding example specifies the HTTP endpoint at

To run Rafiki you must set the environment variables for the `backend`, `auth` and `frontend` services where listed as required below.

:::caution

<VarWarn />
:::

## Backend

Expand Down
13 changes: 4 additions & 9 deletions packages/documentation/src/content/docs/resources/releases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,9 @@ Refer to the Rafiki releases <LinkOut href='https://github.com/interledger/rafik

The latest sources for each of the Rafiki [services](/resources/architecture) are available through GitHub.

- <LinkOut href='https://github.com/interledger/rafiki/tree/main/packages/backend'>
Backend
</LinkOut>
- <LinkOut href='https://github.com/interledger/rafiki/tree/main/packages/auth'>
Auth
</LinkOut>
- <LinkOut href='https://github.com/interledger/rafiki/tree/main/packages/frontend'>
Frontend
</LinkOut>
{/* prettier-ignore */}
- <LinkOut href='https://github.com/interledger/rafiki/tree/main/packages/backend'>Backend</LinkOut>
- <LinkOut href='https://github.com/interledger/rafiki/tree/main/packages/auth'>Auth</LinkOut>
- <LinkOut href='https://github.com/interledger/rafiki/tree/main/packages/frontend'>Frontend</LinkOut>

Alternatively, if you want to run the latest Rafiki version using Docker Compose, then refer to this [guide](/integration/deployment/docker-compose).
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,10 @@ Kratos also enhances security with features like built-in breach detection, secu

Ory Kratos provides frontend components (such as forms and buttons) for identity management flows like login, and account settings. These components are not fixed in design; they are fetched via API calls which allows us to match the identity management components with Rafiki Admin's overall look and feel.

:::danger[Disabling authentication]

<KratosWarn />
:::

## Navigation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@ You can deposit and withdraw asset liquidity through the Rafiki Admin applicatio

## Manage asset liquidity using the Backend Admin API

:::note[Idempotency key]

<IdempotencyNote />
:::

### Deposit asset liquidity

Expand Down
Loading
Loading