docs: add reference to the simple docker compose file in the root pro… (

#1496)

Signed-off-by: Yurii Shynbuiev <yurii.shynbuiev@iohk.io>

README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <a href="https://www.hyperledger.org/projects/identus">
+  <a href="https://www.lfdecentralizedtrust.org/projects/identus">
     <img src="docs/images/logos/identus-logo.svg" alt="identus-logo" width="513px" height="99px" />
   </a>
   <br>
@@ -10,7 +10,7 @@
   <a href="https://github.com/hyperledger/identus-cloud-agent/actions/workflows/unit-tests.yml"> <img src="https://github.com/hyperledger/identus-cloud-agent/actions/workflows/unit-tests.yml/badge.svg" alt="Unit tests" /> </a>
   <a href="https://github.com/hyperledger/identus-cloud-agent/actions/workflows/integration-tests.yml"> <img src="https://github.com/hyperledger/identus-cloud-agent/actions/workflows/integration-tests.yml/badge.svg" alt="End-to-end tests" /> </a>
   <a href="https://github.com/hyperledger/identus-cloud-agent/actions/workflows/performance-tests.yml"> <img src="https://github.com/hyperledger/identus-cloud-agent/actions/workflows/performance-tests.yml/badge.svg" alt="Performance tests" /> </a>
-  <a href="https://scala-steward.org">
+  <a href="https://index.scala-lang.org/scala-steward-org/scala-steward">
       <img src="https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=" alt="Scala Steward badge">
   </a>
 
@@ -58,7 +58,7 @@ All documentation, tutorials and API references for the Identus ecosystem can be
 
 Before starting to use the Cloud Agent, it is important to understand the basic concepts of self-sovereign identity (SSI). The following resources provide a good introduction to SSI:
 
-* [Identus SSI introduction](https://docs.atalaprism.io/docs/category/concepts/)
+* [Identus SSI introduction](https://hyperledger.github.io/identus-docs/docs/category/concepts)
 * [Linux Foundation Course: Getting Started with SSI](https://www.edx.org/learn/computer-programming/the-linux-foundation-getting-started-with-self-sovereign-identity)
 
 ### Architecture
@@ -109,7 +109,7 @@ The Cloud Agent can be configured to use different types of ledger, secret stora
 
 To start playing with Cloud Agent, we recommend using the Dev configuration. Pre-production and production configurations are intended for real-world use cases and require additional more complex configurations of the Distributed Ledger stack setup.
 
-> If you're interested in a hosted version of Cloud Agent, please, contact us via the [Identus site](https://www.hyperledger.org/projects/identus).
+> If you're interested in a hosted version of Cloud Agent, please, contact us via the [Identus site](https://www.lfdecentralizedtrust.org/projects/identus).
 
 #### System requirements
 
@@ -128,12 +128,21 @@ If the Cloud Agent is started successfully, all the running containers should ac
 * `http://localhost:8080/cloud-agent` for the `issuer` instance
 * `http://localhost:8090/cloud-agent` for the `holder` instance
 
-You can check the status of the running containers using the [health endpoint](https://docs.atalaprism.io/agent-api/#tag/System/operation/systemHealth):
+You can check the status of the running containers using the [health endpoint](https://hyperledger.github.io/identus-docs/agent-api/#tag/System/operation/systemHealth):
 ```bash
 $ curl http://localhost:8080/cloud-agent/_system/health
 {"version":"1.19.1"}
 ```
 
+#### Simple docker compose for running the Identus Platform
+
+The Identus Platform is a set of services that work together to provide a complete SSI solution.
+The following services are included in the Identus Platform:
+- Cloud Agent
+- Mediator
+
+The docker compose file and documentation for running the full stack with the simplest configuration (single tenant without authentication) is available [here](https://github.com/hyperledger/identus/blob/main/identus-docker/dockerize-identus.md)
+
 #### Compatibility between Cloud Agent and  PRISM Node
 
 There could be some incompatibilities between the most latest versions of Cloud Agent and  PRISM Node. Please, use the following table to check the compatibility between the versions:
@@ -149,10 +158,10 @@ There could be some incompatibilities between the most latest versions of Cloud
 
 The following tutorials will help you get started with the Cloud Agent and issue your first credentials:
 
-* [Creating, updating and deactivating Decentralized Identifiers (DIDs)](https://docs.atalaprism.io/tutorials/category/dids/)
-* [Setting up connections between agents using out-of-band (OOB) protocol](https://docs.atalaprism.io/tutorials/connections/connection)
-* [Issuing verifiable credentials (VCs)](https://docs.atalaprism.io/tutorials/credentials/issue)
-* [Presenting VC proofs](https://docs.atalaprism.io/tutorials/credentials/present-proof)
+* [Creating, updating and deactivating Decentralized Identifiers (DIDs)](https://hyperledger.github.io/identus-docs/tutorials/category/dids/)
+* [Setting up connections between agents using out-of-band (OOB) protocol](https://hyperledger.github.io/identus-docs/tutorials/connections/connection)
+* [Issuing verifiable credentials (VCs)](https://hyperledger.github.io/identus-docs/tutorials/credentials/didcomm/issue)
+* [Presenting VC proofs](https://hyperledger.github.io/identus-docs/tutorials/credentials/didcomm/present-proof)
 
 ## Contributing
 

cloud-agent/service/server/src/main/scala/org/hyperledger/identus/agent/server/http/DocModels.scala

@@ -65,7 +65,7 @@ object DocModels {
               |It supports DID (Decentralized Identifiers) management, verifiable credential exchange, and secure messaging based on DIDComm standards.
               |The API is designed to be interoperable with various blockchain and DLT (Distributed Ledger Technology) platforms, ensuring wide compatibility and flexibility.
               |Key features include connection management, credential issuance and verification, and secure, privacy-preserving communication between entities.
-              |Additional information and the full list of capabilities can be found in the [Open Enterprise Agent documentation](https://docs.atalaprism.io/docs/category/prism-cloud-agent)
+              |Additional information and the full list of capabilities can be found in the [Open Enterprise Agent documentation](https://hyperledger.github.io/identus-docs/docs/category/prism-cloud-agent)
               |""".stripMargin),
           termsOfService = None,
           contact = None,

cloud-agent/service/server/src/main/scala/org/hyperledger/identus/castor/controller/DIDRegistrarEndpoints.scala

@@ -28,12 +28,12 @@ object DIDRegistrarEndpoints {
     s"""
        |The __${tagName}__ endpoints facilitate the management of [PRISM DIDs](https://github.com/input-output-hk/prism-did-method-spec) hosted in the cloud agent.
        |
-       |Implentation of [DID management](https://docs.atalaprism.io/docs/atala-prism/prism-cloud-agent/did-management/) in the cloud agent.
+       |Implentation of [DID management](https://hyperledger.github.io/identus-docs/docs/atala-prism/prism-cloud-agent/did-management/) in the cloud agent.
        |The agent securely manages and stores DIDs along with their keys in its secret storage.
        |These endpoints allow users to create, read, update, deactivate, and publish without direct exposure to the key material.
        |These DIDs can be utilized for various operations during issuance and verification processes.
        |
-       |More examples and tutorials can be found in this [documentation](https://docs.atalaprism.io/tutorials/category/dids/).
+       |More examples and tutorials can be found in this [documentation](https://hyperledger.github.io/identus-docs/tutorials/category/dids/).
        |""".stripMargin
 
   val tag = Tag(tagName, Some(tagDescription))

cloud-agent/service/server/src/main/scala/org/hyperledger/identus/credentialstatus/controller/http/StatusListCredential.scala

@@ -96,7 +96,7 @@ object StatusListCredential {
 
       object `type`
           extends Annotation[String](
-            description = "Always equals to constnat value - StatusList2021",
+            description = "Always equals to constant value - StatusList2021",
             example = "StatusList2021"
           )
 

cloud-agent/service/server/src/main/scala/org/hyperledger/identus/event/controller/EventEndpoints.scala

@@ -30,7 +30,7 @@ object EventEndpoints {
        |- Issuance protocol notifications
        |- Presentation protocol notifications
        |
-       |For more detailed information regarding event notifications, please refer to this [documentation](https://docs.atalaprism.io/tutorials/webhooks/webhook).
+       |For more detailed information regarding event notifications, please refer to this [documentation](https://hyperledger.github.io/identus-docs/tutorials/webhooks/webhook).
        |""".stripMargin
 
   val tag = Tag(tagName, Some(tagDescription))

cloud-agent/service/server/src/main/scala/org/hyperledger/identus/iam/entity/http/EntityEndpoints.scala

@@ -20,7 +20,7 @@ object EntityEndpoints {
   private val tagName = "Identity and Access Management"
   private val tagDescription =
     s"""
-       |The __${tagName}__ endpoints allow [agent administrators](https://docs.atalaprism.io/docs/concepts/glossary#administrator)
+       |The __${tagName}__ endpoints allow [agent administrators](https://hyperledger.github.io/identus-docs/docs/concepts/glossary#administrator)
        |to manage identity and access management for the agent's tenants.
        |It provides basic built-in IAM capabilities as an alternative to more feature rich external IAM solutions.
        |
@@ -30,7 +30,7 @@ object EntityEndpoints {
        |Additionally, the administrator can create API keys for entities and provide them to the tenants out-of-band.
        |These API keys can then be used for authorization to access specific wallets.
        |
-       |For more detailed information related to the agent IAM and its usage, please refer to this [documentation](https://docs.atalaprism.io/docs/atala-prism/prism-cloud-agent/authentication).
+       |For more detailed information related to the agent IAM and its usage, please refer to this [documentation](https://hyperledger.github.io/identus-docs/docs/atala-prism/prism-cloud-agent/authentication).
        |""".stripMargin
 
   val tag = Tag(tagName, Some(tagDescription))

cloud-agent/service/server/src/main/scala/org/hyperledger/identus/iam/wallet/http/WalletManagementEndpoints.scala

@@ -26,15 +26,15 @@ object WalletManagementEndpoints {
   private val tagName = "Wallet Management"
   private val tagDescription =
     s"""
-       |The __${tagName}__ endpoints enable both users and administrators to manage [wallets](https://docs.atalaprism.io/docs/concepts/multi-tenancy#wallet).
+       |The __${tagName}__ endpoints enable both users and administrators to manage [wallets](https://hyperledger.github.io/identus-docs/docs/concepts/multi-tenancy#wallet).
        |
        |In a multitenant agent, wallet is a container for various resources (e.g. Connections, DIDs) and it isolates the access based on the authorization settings.
-       |[Admnistrator](https://docs.atalaprism.io/docs/concepts/glossary#administrator) can utilize the endpoints to manage and onboard [tenants](https://docs.atalaprism.io/docs/concepts/glossary#tenant).
-       |See [this example](https://docs.atalaprism.io/tutorials/multitenancy/tenant-onboarding-ext-iam) for instructions how to utilize the endpoints for administrator.
+       |[Admnistrator](https://hyperledger.github.io/identus-docs/docs/concepts/glossary#administrator) can utilize the endpoints to manage and onboard [tenants](https://hyperledger.github.io/identus-docs/docs/concepts/glossary#tenant).
+       |See [this example](https://hyperledger.github.io/identus-docs/tutorials/multitenancy/tenant-onboarding-ext-iam) for instructions how to utilize the endpoints for administrator.
        |Tenants can also manage and onboard their own wallets using these endpoints depending on the configuration.
-       |See [this document](https://docs.atalaprism.io/tutorials/multitenancy/tenant-onboarding-ext-iam) for a detailed example for self-service tenants onboarding.
+       |See [this document](https://hyperledger.github.io/identus-docs/tutorials/multitenancy/tenant-onboarding-ext-iam) for a detailed example for self-service tenants onboarding.
        |
-       |Wallet permissions are controlled by [UMA](https://docs.atalaprism.io/docs/concepts/glossary#uma) configuration which the agent
+       |Wallet permissions are controlled by [UMA](https://hyperledger.github.io/identus-docs/docs/concepts/glossary#uma) configuration which the agent
        |exposes endpoints to easily configure wallet access using `uma-permissions` resource.
        |The permissions can also be configured out-of-band directly on the external IAM provider that supports the UMA standard.
        |""".stripMargin

cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialdefinition/CredentialDefinitionRegistryEndpoints.scala

@@ -48,7 +48,7 @@ object CredentialDefinitionRegistryEndpoints {
       |""".stripMargin
 
   private val tagExternalDocumentation = ExternalDocumentation(
-    url = "https://docs.atalaprism.io/tutorials/category/credential-definition",
+    url = "https://hyperledger.github.io/identus-docs/tutorials/category/credential-definition",
     description = Some("Credential Definition documentation")
   )
 

cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialschema/SchemaRegistryEndpoints.scala

@@ -52,7 +52,7 @@ object SchemaRegistryEndpoints {
       |""".stripMargin
 
   private val tagExternalDocumentation = ExternalDocumentation(
-    url = "https://docs.atalaprism.io/tutorials/schemas/credential-schema",
+    url = "https://hyperledger.github.io/identus-docs/tutorials/schemas/credential-schema",
     description = Some("Credential Schema documentation")
   )