Merge branch 'stellar:main' into guide-for-extending-ttl

Author: Mackenzie-OO7

README.md

@@ -2,8 +2,6 @@
 
 Welcome to the official home repository for [Documentation][docs] for the [Stellar network][stellar].
 
-If you're here for the Deep Dive Docs Bounty, please navigate to the bottom of this page for all relevant information: [Deep Dive Docs Bounty](#welcome-to-the-deep-dive-docs-bounty-).
-
 ## Table of Contents <!-- omit in toc -->
 
 - [Contributing](#contributing)
@@ -16,11 +14,6 @@ If you're here for the Deep Dive Docs Bounty, please navigate to the bottom of t
   - [Custom Markdown](#custom-markdown)
     - [Alert](#alert)
     - [Code Example](#code-example)
-- [Welcome to the Deep Dive Docs Bounty 🐙!](#welcome-to-the-deep-dive-docs-bounty-)
-  - [Submission process](#submission-process)
-  - [What makes a good submission](#what-makes-a-good-submission)
-- [Helpful resources](#helpful-resources)
-- [Deep Dive Docs Bounty (not currently running) Eligibility Guidelines](#deep-dive-docs-bounty-eligibility-guidelines)
 
 ## Contributing
 
@@ -238,11 +231,8 @@ const CODE_LANGS = {
   yaml: 'YAML',
 };
 ```
-## Welcome to the Deep Dive Docs Bounty 🐙! (**THE DOCS BOUNTY IS NOW COMPLETED**)
-
-The docs bounty ended on August 7th, 2024. All PRs submitted by end of day Eastern Time on August 7th will be accepted and reviewed. Any submissions made after August 7th are not eligible for the bounty. Thank you to all who participated!
 
-**Remember that this is a community; we build together! 💪 Our code of conduct is [here](https://www.stellar.org/community/code-of-conduct) and our Privacy Policy is [here](https://www.stellar.org/privacy-policy).**
+**Remember that this is a community; we build together! 🫱🏻‍🫲🏽 Our code of conduct is [here](https://www.stellar.org/community/code-of-conduct) and our Privacy Policy is [here](https://www.stellar.org/privacy-policy).**
 
 [docs]: https://developers.stellar.org/docs
 [api]: https://developers.stellar.org/api

ap_versioned_docs/version-2.8.4/README.mdx ap_versioned_docs/version-2.10/README.mdx

@@ -6,11 +6,11 @@ To enable JWT authentication, modify your `dev.env` file:
 # dev.env
 PLATFORM_SERVER_AUTH_TYPE=jwt
 # Will be used to sign the JWT token
-SECRET_PLATFORM_API_AUTH_SECRET="your secret that business server will use" 
+SECRET_PLATFORM_API_AUTH_SECRET="your secret that business server will use"
 ```
 
 </CodeExample>
 
 Anchor Platform uses the HMAC SHA-256 (HS256) algorithm to sign JWT tokens. Ensure that `SECRET_PLATFORM_API_AUTH_SECRET` is at least 32 characters long for security.
 
-Once enabled, all requests must include a valid `Authorization` header with the format `Bearer <JWT token>`.
+Once enabled, all requests must include a valid `Authorization` header with the format `Bearer <JWT token>`.

ap_versioned_docs/version-2.8.4/admin-guide/README.mdx ap_versioned_docs/version-2.10/admin-guide/README.mdx

@@ -0,0 +1,130 @@
+---
+title: Configuration
+sidebar_position: 10
+---
+
+import { CodeExample } from "@site/src/components/CodeExample";
+
+## Custody Server Configuration
+
+If you want to use an external custody service to store and manage your wallets, then you need to deploy one more service - the Custody Server.
+
+This service also needs the `STELLAR_ANCHOR_CONFIG` that was previously mentioned. By default, the `anchor-config-default-values.yaml` config file will be used.
+
+Also, now you don't need to deploy the Stellar Observer since the Custody Server will be responsible for its functionality.
+
+Update the configuration file of the Anchor Platform with the base URL and port.
+
+<CodeExample>
+
+```yaml
+custody_server:
+  # The listening port of the Custody Server.
+  # Default value: 8086
+  port: 8086
+  # The base URL of the Custody Server.
+  # Default value: http://localhost:8086
+  base_url: http://localhost:8086
+```
+
+</CodeExample>
+
+Configure authentication type.
+
+<CodeExample>
+
+```yaml
+custody_server:
+  auth:
+    # Type of authentication that is used when the Anchor Platform communicates with the Custody Server.
+    # Supported values: [none, api_key, jwt]
+    # Default value: none
+    type: none
+```
+
+</CodeExample>
+
+If you set the `api_key` or `jwt` authentication type, then you need to add an environment variable.
+
+<CodeExample>
+
+```bash
+# dev.env
+SECRET_CUSTODY_SERVER_AUTH_SECRET="Custody Server auth secret"
+```
+
+</CodeExample>
+
+Start the Custody Server using Gradle or Docker.
+
+<CodeExample>
+
+```bash
+./gradlew service-runner:bootRun --args=--custody-server
+docker run stellar/anchor-platform:2.10.0 --custody-server
+```
+
+</CodeExample>
+
+## Anchor Platform Configuration
+
+Update the configuration file of the Anchor Platform with the deposit info generator type for SEP-24 and SEP-31. Also, you need to configure a trustline check, if you use JSON-RPC.
+
+<CodeExample>
+
+```yaml
+sep24:
+  # Used to choose how the SEP-24 deposit information (deposit address, memo and memo type) will be generated
+  # Supported value: [self, custody, none]
+  # Default value: self
+  deposit_info_generator_type: custody
+sep31:
+  # Used to choose how the SEP-31 deposit information (deposit address, memo and memo type) will be generated
+  # Supported value: [self, custody, api]
+  # Default value: self
+  deposit_info_generator_type: custody
+  ## Trustline check configuration. Used only when custody integration is enabled
+custody:
+  trustline:
+    ## @param: checkCronExpression
+    ## @type: string
+    ## Cron expression which defines how often a trustline check job runs. By default, a job runs every minute
+    #
+    check_cron_expression: "0 * * * * *"
+    ## @param: checkDuration
+    ## @type: integer
+    ## Determines how long (in MINUTES) the trustline will be checked. By default - 1 hour (60 minutes)
+    #
+    check_duration: 60
+    ## @param: checkTimeoutMessage
+    ## @type: string
+    ## The message that will be added to the SEP transaction after the duration check is exceeded
+    #
+    check_timeout_message: Trustline check timed out
+```
+
+</CodeExample>
+
+:::info
+
+- `self` - memo and memo type are generated in the local code, and the distribution account is used for the deposit address.
+- `custody` - memo and memo type are generated through Custody API, for example Fireblocks, as well as the deposit address.
+- `none` - deposit address, memo, and memo type should be provided by the business in a PATCH/JSON-RPC request.
+- `api` - memo and memo type are generated through calling the anchor's GET /unique_address endpoint.
+
+:::
+
+## Kotlin Reference Server Configuration
+
+Update the configuration file of the Kotlin Reference Server to enable custody integration.
+
+<CodeExample>
+
+```yaml
+app:
+  # Flag that indicates that the custody integration is enabled and the payment will be submitted using the Custody Server.
+  # Default value: false
+  custodyEnabled: true
+```
+
+</CodeExample>