You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
### What
Change Links to the developer documentation. Also went through other
links to the docs site, and updated old links to new locations, where
necessary.
### Why
I moved some of the platform docs around (with redirects), and wanted to
update the source links, as well.
> If you are using version 1.x.x, we highly recommend upgrading to version 2.x.x to benefit from the latest features, routine fixes, and security patches.
29
-
> For detailed instructions on how to upgrade, please refer to [the upgrade guide](https://developers.stellar.org/network/stellar-disbursement-platform/admin-guide/single-tenant-to-multi-tenant-migration).
28
+
> If you are using version 1.x.x, we highly recommend upgrading to version 2.x.x to benefit from the latest features, routine fixes, and security patches.
29
+
> For detailed instructions on how to upgrade, please refer to [the upgrade guide](https://developers.stellar.org/docs/platforms/stellar-disbursement-platform/admin-guide/single-tenant-to-multi-tenant-migration).
To quickly test the SDP using preconfigured values, use the startup wizard.
53
53
@@ -57,7 +57,7 @@ make setup
57
57
58
58
For more information about launching and configuring the SDP, see the [Quick Start Guide](./dev/README.md).
59
59
60
-
### Helm
60
+
### Helm
61
61
62
62
To deploy the SDP using Helm, see the [Helm Chart](./helmchart/sdp/README.md).
63
63
@@ -178,7 +178,7 @@ The SEP10/SEP24 implementation can be configured using the following environment
178
178
SEP10_SIGNING_PUBLIC_KEY=G... # Public key for SEP10 signing
179
179
SEP10_SIGNING_PRIVATE_KEY=S... # Private key for SEP10 signing
180
180
181
-
# SEP24 Configuration
181
+
# SEP24 Configuration
182
182
SEP24_JWT_SECRET=jwt_secret_... # JWT secret for SEP24 tokens
183
183
```
184
184
@@ -190,7 +190,7 @@ The following environment variables are required for SEP10/SEP24 functionality:
190
190
191
191
**Required Variables:**
192
192
-`SEP10_SIGNING_PUBLIC_KEY` - Public key for SEP10 challenge signing
193
-
-`SEP10_SIGNING_PRIVATE_KEY` - Private key for SEP10 challenge signing
193
+
-`SEP10_SIGNING_PRIVATE_KEY` - Private key for SEP10 challenge signing
194
194
-`SEP24_JWT_SECRET` - JWT secret for SEP24 token signing
195
195
196
196
**Optional Variables:**
@@ -207,9 +207,9 @@ The SDP Core service include several components started using a single command.
207
207
stellar-disbursement-platform serve --help
208
208
```
209
209
210
-
#### Admin API
210
+
#### Admin API
211
211
212
-
The Admin API is the component responsible for managing tenants of the SDP. It runs by default on port 8003 and is used to provision new tenants and manage existing tenants.
212
+
The Admin API is the component responsible for managing tenants of the SDP. It runs by default on port 8003 and is used to provision new tenants and manage existing tenants.
@@ -371,8 +371,8 @@ The SDP uses Background jobs to handle asynchronous tasks.
371
371
372
372
**1. Jobs**
373
373
374
-
> [!NOTE]
375
-
> Certain jobs are not listed here because they cannot be configured and are necessary to the functioning of the SDP.
374
+
> [!NOTE]
375
+
> Certain jobs are not listed here because they cannot be configured and are necessary to the functioning of the SDP.
376
376
377
377
*`send_receiver_wallets_invitation_job`: This job is used to send disbursement invites to recipients. Its interval is configured through the `SCHEDULER_RECEIVER_INVITATION_JOB_SECONDS` environment variable.
378
378
*`payment_to_submitter_job`: This job is used to submit payments from Core to the TSS. Its interval is configured through the `SCHEDULER_PAYMENT_JOB_SECONDS` environment variable.
Copy file name to clipboardExpand all lines: cloudformation/eks/README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ This guide walks through deploying the Stellar Disbursement Platform (SDP) infra
41
41
- Creates EKS cluster and node group
42
42
- Sets up IAM roles and security groups
43
43
- Configures IRSA (IAM Roles for Service Accounts)
44
-
- Sets up permissions for pods to access secrets stored in AWS Secrets Manager
44
+
- Sets up permissions for pods to access secrets stored in AWS Secrets Manager
45
45
46
46
After the CloudFormation stacks are deployed, additional Kubernetes resources are installed via Helm charts to complete the setup. The SDP expects secrets to be available as Kubernetes secrets, but how those secrets are synchronized (whether through ExternalSecrets, direct creation, or other means) is left to the deployer's preference.
for a description of these parameters, please see: [Configuring the SDP](https://developers.stellar.org/platforms/stellar-disbursement-platform/admin-guide/configuring-sdp)
110
+
for a description of these parameters, please see: [Configuring the SDP](https://developers.stellar.org/docs/platforms/stellar-disbursement-platform/admin-guide/configuring-sdp)
The SDP platform uses two base-level domains for multi-tenant frontend and backend access. For example, lets say your hosted public domain is `api.example.org`. Then, you could configure a subdomain called `api.example.org` as the base-level domain for api access and `dashboard.example.org` as the front-end dashboard base-level domain. If you then added a tenant (eg `ridedash`) to the SDP, the api and dashboard URLs for them would be `ridedash.api.example.org` and `ridedash.dashboard.example.org` respectively. you can see this example in the helm-example-values file.
377
+
The SDP platform uses two base-level domains for multi-tenant frontend and backend access. For example, lets say your hosted public domain is `api.example.org`. Then, you could configure a subdomain called `api.example.org` as the base-level domain for api access and `dashboard.example.org` as the front-end dashboard base-level domain. If you then added a tenant (eg `ridedash`) to the SDP, the api and dashboard URLs for them would be `ridedash.api.example.org` and `ridedash.dashboard.example.org` respectively. you can see this example in the helm-example-values file.
378
378
379
379
## Example Helm Values configuration
380
380
The following illustrates the example configuration for backend (api) and frontend (dashboard) base domains for the public domain `example.org`. Note, these domains must have a wild-card certificate.
@@ -392,7 +392,7 @@ dashboard:
392
392
393
393
The following illustrates the kubernetes configurations that result from the above helm values.
8. To verify the payment, enter the passcode and date of birth. You can use `000000` passcode or find the actual passcode in the `sdp-api` container logs.
@@ -325,7 +332,7 @@ You need to create and configure two Stellar accounts to use the SDP. You can ei
325
332
326
333
**Option 1: Manually Create and Configure Accounts**
327
334
328
-
1. Create and fund a Distribution account that will be used for sending funds to receivers. Follow the instructions [here](https://developers.stellar.org/docs/stellar-disbursement-platform/getting-started#create-and-fund-a-distribution-account).
335
+
1. Create and fund a Distribution account that will be used for sending funds to receivers. Follow the instructions [here](https://developers.stellar.org/docs/platforms/stellar-disbursement-platform/getting-started#create-and-fund-a-distribution-account).
329
336
2. Create a SEP-10 account for authentication. It can be created the same way as the distribution account but it doesn't need to be funded.
330
337
3. Create a `.env` file in the `dev` directory by copying the [env.example](.backup/.env.example) file:
0 commit comments