Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
73067d3
Update identity documentation heading
patextreme Jan 15, 2026
efe2941
Make Introduction page visible in sidebar
patextreme Jan 15, 2026
9c830ac
Rename identity.md to about-hyperledger-identus.md
patextreme Jan 15, 2026
ecd2b93
Restructure learn section documentation
patextreme Jan 15, 2026
b53c1aa
Restructure learn documentation with category-based navigation
patextreme Jan 15, 2026
8b3c5d8
Replace introduction with what-is-hyperledger-identus
patextreme Jan 15, 2026
6e3cebd
Add basic concepts documentation for Identus
patextreme Jan 15, 2026
50ca274
Update image references in basic concepts documentation
patextreme Jan 15, 2026
472e351
Flatten documentation directory structure
patextreme Jan 15, 2026
76688dc
Remove introductory content from quick start guide
patextreme Jan 15, 2026
907a8e8
Change Developers menu label to Develop
patextreme Jan 15, 2026
837c2e6
Rename components to advanced-explainers and update references
patextreme Jan 15, 2026
1af0d12
Update Advanced explainers links and sidebar metadata
patextreme Jan 15, 2026
10d2a54
Add tracking document for issue #235 leftovers
patextreme Jan 15, 2026
873449c
Update advanced explainers link paths
patextreme Jan 15, 2026
40787de
Rename developers documentation folder to develop
patextreme Jan 16, 2026
c20a4bc
Add related tutorials sections to advanced explainer docs
patextreme Jan 16, 2026
613410d
Remove temporary leftovers documentation file
patextreme Jan 16, 2026
9392e3b
Update self-sovereign identity links to internal documentation
patextreme Jan 16, 2026
b78d3f5
Fix documentation internal link paths
patextreme Jan 19, 2026
05dfb59
Merge branch 'main' into docs-improvements
patextreme Jan 19, 2026
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
Original file line number Diff line number Diff line change
Expand Up @@ -182,4 +182,4 @@ All SDKs include sample applications demonstrating end-to-end flows:

---

Ready to start building? Head to the [Quick Start Guide](./quick-start.md) to deploy your first Identus application!
Ready to start building? Head to the [Quick Start Guide](./quick-start.md) to deploy your first Identus application!
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The legacy PRISM Node implementation uses gRPC for communication and has been th

NeoPRISM is an open-source alternative implementation written in Rust. It provides the same DID management capabilities with improved resource efficiency and a modern HTTP/REST API. NeoPRISM is designed for easy deployment with Docker and supports multiple deployment modes.

For more information about NeoPRISM, see the [NeoPRISM component documentation](/docs/documentation/learn/components/neoprism/).
For more information about NeoPRISM, see the [NeoPRISM component documentation](/documentation/learn/advanced-explainers/neoprism/).

## Configuration

Expand Down Expand Up @@ -76,7 +76,7 @@ To use PRISM Node as the backend, you need:
- A deployed PRISM Node instance
- Network connectivity to the PRISM Node service

For detailed instructions on deploying and running PRISM Node, see the [Running PRISM Node](/docs/documentation/learn/components/prism-node/running-node) documentation.
For detailed instructions on deploying and running PRISM Node, see the [Running PRISM Node](/documentation/learn/advanced-explainers/prism-node/running-node) documentation.

### For NeoPRISM (Recommended)

Expand All @@ -95,7 +95,7 @@ Additionally, you need:
- **Cardano Wallet:** A configured Cardano wallet for submitting operations to the blockchain
- **Cardano Network Sources:** Connectivity to the Cardano network (mainnet, preprod, or testnet). This might be a Cardano relay node or a DBSync instance

For detailed instructions on deploying and running NeoPRISM in standalone mode, see the [Running NeoPRISM](/docs/documentation/learn/components/neoprism/running-neoprism) documentation.
For detailed instructions on deploying and running NeoPRISM in standalone mode, see the [Running NeoPRISM](/documentation/learn/advanced-explainers/neoprism/running-neoprism) documentation.

## Migration Guide

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,57 +6,6 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Quick Start Guide
## Introduction into Self Sovereign Identity (SSI)
[Self-sovereign identity (SSI)](/documentation/learn/glossary/#self-sovereign-identity) is complex. This Quick Start Guide explains the fundamental concepts to get up and running with Hyperledger Identus. This guide will familiarize you with the general concepts and how to create [decentralized identifiers (DIDs)](/documentation/learn/glossary/#decentralized-identifier), issue credentials, make connections, and verify credentials with [verifiable presentations](/documentation/learn/glossary/#verifiable-presentation). Refer to the Concepts and Components sections for a more in-depth explanation.

The trust triangle is the most basic process for conveying trust in the digital world. There are three roles in an SSI ecosystem: [Holders](/documentation/learn/glossary/#holder), [Issuers](/documentation/learn/glossary/#issuer), and [Verifiers](/documentation/learn/glossary/#verifier).

![Component Diagram](/img/trust-triangle.png)

Holders can be any entity, such as individuals, organizations, and digital or physical things. They will hold [verifiable credentials (VCs)](/documentation/learn/glossary/#verifiable-credential) and use a verifiable presentation to share their VCs.

Issuers can also be any entity that makes [claims](/documentation/learn/glossary/#claim) about an [entity](/documentation/learn/glossary/#entity). These claims are attestations, or evidence of something, about the Holder. As an example, an insurance company would provide proof of valid insurance.

Verifiers are the [relying party](/documentation/learn/glossary/#relying-party) in the triangle. They will request information from the Holder, such as proof of insurance, and the Holder will use a verifiable presentation to share the appropriate VCs with the Verifier. The Holder's digital signature, the issuer DID get verified, and the contents therein to ensure nothing has been tampered with.



## Hyperledger Identus flow
The diagram details how the concepts fit alongside the Identus components in a typical SSI interaction.

![Component Diagram](/img/component-diagram.png)



## An overview of Hyperledger Identus components
Identus consists of core libraries that facilitate typical SSI interactions between [Issuers](/documentation/learn/glossary/#issuer), [Holders](/documentation/learn/glossary/#holder), and [Verifiers](/documentation/learn/glossary/#verifier).


### A Cloud Agent
A Cloud Agent can issue, hold, and verify [verifiable credentials (VCs)](/documentation/learn/glossary/#verifiable-credential) for any entity and manage [decentralized identifiers (DIDs)](/documentation/learn/glossary/#decentralized-identifier) and DID-based connections. The Cloud Agent has an easy-to-use REST API to enable easy integration into any solution and uses [DIDComm V2](/documentation/learn/glossary/#didcomm) as a messaging protocol for Cloud Agent-to-Cloud Agent communication.

It is maintained as an open source through the [Hyperledger Identus](https://www.hyperledger.org/projects/identus).

More in depth documentation about [Cloud Agent](/documentation/learn/glossary/#cloud-agent) can be found [here](/home/identus/cloud-agent/overview).



### Wallet SDKs
[Wallet SDKs](/documentation/learn/glossary/#wallet-sdk) for web and mobile (iOS, Android, TypeScript) enable identity holders to store credentials and respond to proof requests. They are typically used in applications that allow identity holders to interact with issuers and verifiers.

More in-depth documentation about the different Wallet SDKs can be found here ([TypeScript](https://hyperledger-identus.github.io/docs/sdk-ts/sdk/), [Swift](https://hyperledger-identus.github.io/sdk-swift/documentation/edgeagentsdk/), [KMP](https://hyperledger-identus.github.io/sdk-kmp/))



### Mediator
[Mediators](/documentation/learn/glossary/#mediator) are for storing and relaying messages between Cloud Agents and Wallet SDKs. They act as a proxy that remains connected to the network and receives any message, credential, or proof request on behalf of the Wallet SDKs (which can be offline occasionally).

More in-depth documentation about Mediator can be found [here](/home/identus/mediator).

#### Node for a Verifiable Data Registry (VDR)
To issue and verify VCs to and from DIDs, we need a [Verifiable Data Registry (VDR)](/documentation/learn/glossary/#verifiable-data-registry) that is globally resolvable and always on. In Identus's case, it is `prism-node`, [anchoring](/documentation/learn/glossary/#anchoring) key information required for issuance and verification on the Distributed Ledger.



## Pre-Requisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ const converted = tutorialsSidebar
const sidebar: SidebarsConfig[keyof SidebarsConfig] = [
{
type: 'doc',
id: 'documentation/developers/README',
id: 'documentation/develop/README',
className: 'hidden-sidebar-item',
},
{
Expand Down Expand Up @@ -157,13 +157,13 @@ const sidebar: SidebarsConfig[keyof SidebarsConfig] = [
id: 'cloud-agent/docs/docusaurus/index'
},
items: [
'documentation/developers/quick-start',
'documentation/develop/quick-start',
...converted
]
},
{
type: 'autogenerated',
dirName: 'documentation/developers/cloud-agent',
dirName: 'documentation/develop/cloud-agent',
},
]
},
Expand Down
28 changes: 9 additions & 19 deletions documentation/learn/README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,15 @@
---
id: README
title: Introduction
Comment thread
patextreme marked this conversation as resolved.
sidebar_position: 1
sidebar_class_name: hidden-sidebar-item
---
# About Hyperledger Identus
Identity is about access. It is the key that unlocks doors we wish to enter. To stream movies, we need access to get into the virtual theater. Today, we do that by having an account with a streaming service, which authenticates us into the lobby.

# Introduction
We need authorization to enter the theater to watch the movie, which requires a service plan. Which selection will determine whether we can watch in standard, high definition, or 4k.

Hyperledger Identus is a comprehensive toolset that provides the necessary infrastructure for decentralized identity systems. It operates as a layer-2 blockchain solution, using a distributed ledger as a [verifiable data registry (VDR)](./concepts/glossary#verifiable-data-registry). This innovative toolset facilitates the creation and management of decentralized identifiers (DIDs) and supports the issuance, updating, and revocation of verifiable credentials. With this technology, users can securely and efficiently manage their digital identities while ensuring the integrity and authenticity of their credentials.
This example is repeatable across all interactions: banking, insurance, online services, shopping, investing, education, traveling, driving, etc. Identity may be the most essential thing we undervalue in our lives. We use it to physically and digitally access goods and services locally and globally.

Hyperledger Identus is deeply rooted in the concept of [self-sovereign identity (SSI)](./concepts/glossary#self-sovereign-identity), a powerful feature that empowers users to control their identity and personal information. With SSI, users can selectively disclose their data using asymmetric cryptography, giving them full control over their digital identity.
## Self-Sovereign Identity (SSI)
[Self-sovereign identity](/documentation/learn/glossary/#self-sovereign-identity) introduces new concepts that flip the existing identity models. The control shifts from the central authorities to the edges, with individuals. SSI is a set of principles that leverage decentralized identity technology. Sovrin compiled a list of the principles in an easy-to-digest format, available [here](https://sovrin.org/principles-of-ssi/).

The documentation herein will explain the following:
The World Wide Web Consortium (W3C) organization has been setting the standards for the Internet as we know it. Similarly, they are also working on next-generation technologies such as decentralized identity. In July 2022, the W3C approved the DID specification to become a [recommendation](https://www.w3.org/press-releases/2022/did-rec/).

* Decentralized identity concepts
* How Hyperledger Identus works
* Hyperledger Identus Quick Start Guide
The W3C has compiled a list in addition to the specifications for all DID methods available [here](https://www.w3.org/TR/did-spec-registries/).

## Supported Standards
* W3C DID Specification
* DIDComm v2
* W3C VC-JWT
* Hyperledger Anoncreds
* OpenID for Verifiable Credential Issuance
For a deep dive into the DID specification itself, the W3C standard is [here](https://www.w3.org/TR/did-core/).
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"label": "Components",
"label": "Advanced explainers",
"position": 3,
"collapsed": false,
"collapsible": false,
"link": {
"type": "generated-index",
"title": "Components",
"title": "Advanced explainers",
"description": "Technical reference documentation including ADRs, specifications, and API details."
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,8 @@ This document provides an overview of the Cloud Agent feature set. This document
| [0434-out-of-band-protocol](https://github.com/hyperledger/aries-rfcs/blob/main/features/0434-outofband/README.md) | :white_check_mark: |
| [0453-issue-credential-protocol](https://github.com/hyperledger/aries-rfcs/tree/main/features/0453-issue-credential-v2) | :white_check_mark: |
| [0453-present-proof-protocol](https://github.com/hyperledger/aries-rfcs/tree/main/features/0454-present-proof-v2) | :white_check_mark: |

## Related Tutorials

- [Quick Start Guide](/documentation/develop/quick-start.md) - Get started with Cloud Agent deployment and credential flows
- [Cloud Agent Tutorials](/cloud-agent/docs/docusaurus/index.md) - Complete tutorials for connections, DIDs, credentials, and multi-tenancy
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,8 @@ graph TB;
Entity(Entity) -->|Uses| AuthMethod(Authentication Method)
end
```

## Related Tutorials

- [Tenant Onboarding](/cloud-agent/docs/docusaurus/multitenancy/tenant-onboarding) - Set up multi-tenant infrastructure
- [Tenant Onboarding with External IAM](/cloud-agent/docs/docusaurus/multitenancy/tenant-onboarding-ext-iam) - Integrate with Keycloak for JWT authentication
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The publicly available NeoPRISM can be used to resolve PRISM DIDs and retrieve t
The instance of NeoPRISM for the PRISM DIDs published in the Cardano mainnet is:
[https://neoprism.patlo.dev/resolver](https://neoprism.patlo.dev/resolver)

For more details on integrating NeoPRISM with the Cloud Agent, see the [NeoPRISM documentation](/docs/documentation/learn/components/neoprism/).
For more details on integrating NeoPRISM with the Cloud Agent, see the [NeoPRISM documentation](/documentation/learn/advanced-explainers/neoprism/).

### PRISM Indexer

Expand Down Expand Up @@ -77,3 +77,10 @@ Its fetchs the all PRISM events from one DID from the Prism-VDR Github repos and

A instance of this tool can be found in [did.fmgp.app](https://did.fmgp.app/#/resolver/did:prism:00592a141a4c2bcb7a6aa691750511e2e9b048231820125e15ab70b12a210aae).
Its capable of resolving some DID methods including the `did:prism`.

## Related Tutorials

- [Create DIDs](/cloud-agent/docs/docusaurus/dids/create) - Create Cloud Agent-managed DIDs
- [Publish DIDs](/cloud-agent/docs/docusaurus/dids/publish) - Publish DIDs to the ledger
- [Update DIDs](/cloud-agent/docs/docusaurus/dids/update) - Update existing DIDs
- [Deactivate DIDs](/cloud-agent/docs/docusaurus/dids/deactivate) - Deactivate DIDs when no longer needed
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@

The Node is a level 2 proxy on top of the Cardano blockchain responsible for publishing, resolving, updating, and deactivating DIDs. It exposes a gRPC API to perform all the operations above.

:::note
This documentation will not describe the gRPC API itself.
:::

The Identus cloud Agent communicates with the Node, with all operations conducted through it. The following documentation will provide a high-level overview of how the Node functions and explain its usage, including the environment variables required and how to deploy it to the Cardano mainnet and testnet.

## Node components
Expand Down Expand Up @@ -141,4 +137,4 @@ Node DB is a simple PostgreSQL database.

Cardano wallet is an application that communicates with the Cardano network; it functions as a server that you can start and connect to either the mainnet or testnet. You must provide the Node runnable's host and port as environment variables.

DB-sync is an application responsible for syncing the Cardano blockchain with a PostgreSQL database. It would help if you used it to sync with either the mainnet or testnet and must provide the database host with port, database name, and credentials as environment variables to the Node runnable.
DB-sync is an application responsible for syncing the Cardano blockchain with a PostgreSQL database. It would help if you used it to sync with either the mainnet or testnet and must provide the database host with port, database name, and credentials as environment variables to the Node runnable.
Loading