From 07e656f932cb59295b7b65df0e7c5b77a6b6de08 Mon Sep 17 00:00:00 2001 From: puria Date: Thu, 4 Apr 2024 14:29:14 +0200 Subject: [PATCH] feat: Add deployment instructions --- docs/.vitepress/config.mts | 20 +++++--- docs/core-technologies.md | 46 +++++++++++++----- docs/dashboard.md | 26 ---------- docs/index.md | 6 +-- docs/{getting-started.md => intro.md} | 6 +-- docs/quickstart.md | 70 +++++++++++++++++++++++++++ docs/solution.md | 49 +++++++++++++------ 7 files changed, 160 insertions(+), 63 deletions(-) delete mode 100644 docs/dashboard.md rename docs/{getting-started.md => intro.md} (97%) create mode 100644 docs/quickstart.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 283d087..a886332 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -13,13 +13,20 @@ export default defineConfig({ // https://vitepress.dev/reference/default-theme-config nav: [ { text: "Home", link: "/" }, - { text: "Reference", link: "/getting-started" }, + { text: "Reference", link: "/intro" }, + { text: "Quick start", link: "/quickstart" }, ], sidebar: [ { - text: "🚀 Getting started", - link: "/getting-started", + text: "📖 Introduction ", + link: "/intro", + items: [ + { text: "How it works?", link: "/intro#how-it-works", }, + { text: "Features", link: "/intro#features", }, + { text: "Integration and flexibility", link: "/intro#integration-and-flexibility", }, + { text: "How it works?", link: "/intro#how-it-works", }, + ] }, { text: "🏗️ Core Technologies", @@ -47,13 +54,14 @@ export default defineConfig({ ], }, { - text: "Deployment options", + text: "🎮 Quickstart", + link: "/quickstart", items: [ { text: "Software as a Service (SaaS)", - link: "#software-as-a-service-saas", + link: "/quickstart#software-as-a-service-saas", }, - { text: "On-Premise deployment", link: "#on-premise-deployment" }, + { text: "On-Premise deployment", link: "/quickstart#on-premise-deployment" }, ], }, { diff --git a/docs/core-technologies.md b/docs/core-technologies.md index 346f977..cf458d4 100644 --- a/docs/core-technologies.md +++ b/docs/core-technologies.md @@ -1,23 +1,47 @@ # 🏗️ Core Technologies ## 🔐 Zenroom - Zenroom is responsible for all underlying cryptographic operations within the DiDRoom ecosystem. It provides a secure execution environment for cryptographic operations and smart contracts, ensuring privacy, security, and integrity in digital interactions. Notably, Zenroom runs isomorphically on the web, mobile, and servers across various platforms in a deterministic way. - - [Documentation](https://dev.zenroom.org/) - - [GitHub](https://github.com/dyne/zenroom) - - [Site](https://zenroom.org/) + Zenroom is responsible for all underlying cryptographic operations within the Didroom ecosystem. It provides a secure execution environment for cryptographic operations and smart contracts, ensuring privacy, security, and integrity in digital interactions. Notably, Zenroom runs isomorphically on the web, mobile, and servers across various platforms in a deterministic way. + + ::: tip RESOURCES + + [Documentation](https://dev.zenroom.org/) + + [GitHub](https://github.com/dyne/zenroom) + + [Site](https://zenroom.org/) + + ::: ## 📜 Slangroom Slangroom enhances the Zencode language of Zenroom by allowing the addition of plugins. These plugins extend the functionality of Zencode by enabling actions that do not necessarily need to be performed within virtual machines. Slangroom's approach is super standard, making it easy to add custom functionalities within the Zencode natural language. Additionally, Slangroom is capable of running over web pages using WebAssembly. - - [Documentation](https://dyne.org/slangroom) - - [GitHub](https://github.com/syne/slangroom) + + ::: tip RESOURCES + + [Documentation](https://dyne.org/slangroom) + + [GitHub](https://github.com/syne/slangroom) + + ::: ## 🛠️ No-code-room (NCR) No-code-room is a Single Executable Application (SEA) for Linux. It takes a filesystem with .zen (Zencode/Slangroom) contracts and creates API microservices using live-directory routing. NCR seamlessly generates REST services that are auto-documented with OpenAPI. Additionally, it creates small graphic interfaces on the fly, referred to as applets. - - [GitHub](https://github.com/forkbombeu/ncr) + ::: tip RESOURCES + + [GitHub](https://github.com/forkbombeu/ncr) + + ::: ## 🔗 Dyne.org Decentralized Identifiers (DID) Service In 2022, Dyne.org implemented a W3C-DID method approved by the W3C governing board and included in the official DID method list. The DID service supports federation and provides tools for the creation, resolution, and management of decentralized identifiers (DIDs). It includes support for ECDSA, EDDSA, Schnorr, Ethereum address, as well as a Dilithium quantum-proof public key. - - [GitHub](https://github.com/dyne/w3c-did) - - [Online DIDs Explorer](https://explorer.did.dyne.org/) - - [Specification](https://dyne.org/W3C-DID/) - - [Site](https://forkbomb.solutions/component/w3c-did-federate-service/) + ::: tip RESOURCES + + [GitHub](https://github.com/dyne/w3c-did) + + [Online DIDs Explorer](https://explorer.did.dyne.org/) + + [Specification](https://dyne.org/W3C-DID/) + + [Site](https://forkbomb.solutions/component/w3c-did-federate-service/) + + ::: diff --git a/docs/dashboard.md b/docs/dashboard.md deleted file mode 100644 index e95b5be..0000000 --- a/docs/dashboard.md +++ /dev/null @@ -1,26 +0,0 @@ -## Quickstart - -```shell -git clone --recursive https://github.com/forkbombeu/signroom -docker compose up - -``` - -The user name and pass are: - -head your browser to `http://localhost:8090/_` - -::: warning -Pay attention at the underscore as the `path` for the admin section -::: - - -::: tip -default username and password are: - -`admin@example.org` -`adminadmin` -::: - - -## Configuration \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index e7867a0..5c9a4b5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,9 +9,9 @@ hero: image: src: https://forkbomb.solutions/wp-content/uploads/2023/05/DIDroom_logo.svg actions: - - theme: alt - text: 🚀 Quickstart - link: /getting-started + - theme: brand + text: 🎮 Quickstart + link: /quickstart - theme: brand text: JOIN NOW ↗ link: https://beta.signroom.io/register/ diff --git a/docs/getting-started.md b/docs/intro.md similarity index 97% rename from docs/getting-started.md rename to docs/intro.md index c6bf109..d0b37e9 100644 --- a/docs/getting-started.md +++ b/docs/intro.md @@ -1,4 +1,4 @@ -# Getting Started +# 📖 Introduction Welcome to Didroom – your gateway to decentralized identity management and secure communication. Didroom empowers individuals and organizations to take control of their digital identities while ensuring privacy and security. Whether you're looking to streamline identity verification processes, enhance data security, or enable secure communication channels, Didroom provides the tools and infrastructure you need. @@ -30,11 +30,11 @@ Didroom offers a seamless and intuitive experience for managing decentralized id - **Decentralized identity management:** Didroom enables users to create, control, and manage their digital identities in a decentralized manner, eliminating reliance on central authorities. - **Customizable and extensible:** Didroom is highly customizable and extensible, allowing organizations to tailor the platform to their specific needs and integrate with existing systems seamlessly. -## Integration and Flexibility +## Integration and flexibility Didroom is designed to be seamlessly integrated into third-party solutions and environments. Its modular architecture allows for easy integration with existing microservices or other identity management systems. Whether you need to use Didroom as a standalone solution or integrate it into your existing infrastructure, Didroom provides the flexibility and adaptability you need. -## Architectural Overview +## Architectural overview The Didroom ecosystem consists of a modular architecture comprising core technologies and components: - **Core Technologies:** Zenroom, Slangroom, No-code-room, and Dyne.org Decentralized Identifiers (DID) Service provide the foundational elements for identity management and cryptographic operations. diff --git a/docs/quickstart.md b/docs/quickstart.md new file mode 100644 index 0000000..dfecae6 --- /dev/null +++ b/docs/quickstart.md @@ -0,0 +1,70 @@ +# 🎮 Quickstart + +Get started quickly with Didroom by choosing one of the following deployment options: + +## Software as a Service (SaaS) + +If you prefer a hassle-free experience and want to start using Didroom without setting up infrastructure, our Software as a Service (SaaS) option is the way to go. Follow these steps to get started: + +1. Sign up for a Didroom account on our website. + +