From 22850b6add622d56818f152aff6f329991966e1d Mon Sep 17 00:00:00 2001 From: Alex Fornuto Date: Thu, 14 Nov 2024 14:23:24 -0600 Subject: [PATCH] consolidate files and fix paths --- doc/{deployment_guide.md => deployment/index.mdx} | 7 +++---- doc/{mdip => deployment}/mdip-keymaster-webui.png | Bin doc/{mdip => deployment}/mdip-resource-usage.png | Bin doc/{mdip => deployment}/mdip_components.png | Bin 4 files changed, 3 insertions(+), 4 deletions(-) rename doc/{deployment_guide.md => deployment/index.mdx} (99%) rename doc/{mdip => deployment}/mdip-keymaster-webui.png (100%) rename doc/{mdip => deployment}/mdip-resource-usage.png (100%) rename doc/{mdip => deployment}/mdip_components.png (100%) diff --git a/doc/deployment_guide.md b/doc/deployment/index.mdx similarity index 99% rename from doc/deployment_guide.md rename to doc/deployment/index.mdx index 02bd5a35..680e6a80 100644 --- a/doc/deployment_guide.md +++ b/doc/deployment/index.mdx @@ -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). @@ -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. @@ -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. @@ -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. diff --git a/doc/mdip/mdip-keymaster-webui.png b/doc/deployment/mdip-keymaster-webui.png similarity index 100% rename from doc/mdip/mdip-keymaster-webui.png rename to doc/deployment/mdip-keymaster-webui.png diff --git a/doc/mdip/mdip-resource-usage.png b/doc/deployment/mdip-resource-usage.png similarity index 100% rename from doc/mdip/mdip-resource-usage.png rename to doc/deployment/mdip-resource-usage.png diff --git a/doc/mdip/mdip_components.png b/doc/deployment/mdip_components.png similarity index 100% rename from doc/mdip/mdip_components.png rename to doc/deployment/mdip_components.png