Skip to content

Commit

Permalink
consolidate files and fix paths
Browse files Browse the repository at this point in the history
  • Loading branch information
alexfornuto committed Nov 14, 2024
1 parent 15713fd commit 22850b6
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions doc/deployment_guide.md → doc/deployment/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Keychain MDIP Full Trustless Node Deployment Guide
sidebar_label: Deployment
slug: deployment
---

Keychain MDIP is a suite of software tools, libraries, and services that implement the Multi-Dimensional Identity Protocol as defined and documented by the [MDIP DID Scheme](/docs/mdip/scheme). This document refers to the [MDIP v.0.3-beta release](https://github.com/KeychainMDIP/kc/releases/tag/v0.3-beta).
Expand Down Expand Up @@ -52,7 +51,7 @@ The MDIP [Integration Guide](https://github.com/KeychainMDIP/kc/blob/ab36a8a7b3b

### MDIP Components

![MDIP-components](https://github.com/user-attachments/assets/c88a33f0-aa61-48b9-a62a-ca956f1038d9)
![MDIP-components](./mdip_components.png)

All the MDIP components illustrated above are composed together using Docker Compose in the official ['kc' v.0.3-beta](https://github.com/KeychainMDIP/kc/releases/tag/v0.3-beta) release. The release provides a simple [`start-node`](https://github.com/KeychainMDIP/kc/blob/v0.3-beta/start-node) script that will compile, dockerize, and launch all required MDIP components. The convenience of this script will be preserved as we explore configuration and deployment options below.

Expand All @@ -61,7 +60,7 @@ Each MDIP component can also be manually launched using native nodeJS commands.

While perhaps not optimal for a production environment, developement environments can be deployed with all the required components on a single moderately-sized server. The statistics below demonstrate a typical development environment:

![MDIP-resources](https://github.com/user-attachments/assets/7d63d4dc-fa51-4254-b9ad-94b91d98f78d)
![MDIP-resources](./mdip-resource-usage.png)

- kc-gatekeeper-1 is the MDIP Gatekeeper, a reference implementation of the [MDIP DID Scheme] (https://keychain.org/docs/mdip/scheme) exposing a REST API interface.
- kc-keymaster-1 is the MDIP Keymaster, which provides an interface to the server's keymaster wallet and expose a REST [Keymaster API](https://keychain.org/docs/keychain/library/api/) to manage the server's MDIP identity.
Expand Down Expand Up @@ -794,7 +793,7 @@ This section contains tips and information on how to get started with your new M

The MDIP Gatekeeper offers a developer-friend identity wallet on port `4224` that can be used to interact with the protocol.

![Screenshot 2024-10-28 at 17 09 19](https://github.com/user-attachments/assets/6763e0a6-706b-418f-bd28-33efa6ea0cca)
![Keymaster Wallet UI](mdip-keymaster-webui.png)

Most of the Keymaster functions are available over the Keymaster web UI. Documentation for the Keymaster web UI is available in the [Keymaster Web UI](/docs/keychain/clients/webui/) section.

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes

0 comments on commit 22850b6

Please sign in to comment.