One37 Identity Platform Quick Setup Guide
From Zero to Go
This document is a guide to quickly install and configure the One37 Platform from scratch. It is intended for developers and system administrators who are new to the platform and want to get up and running quickly. It assumes a basic understanding of the platform and its components, as well as some experience with system administration and software development.
It is not intended to be a comprehensive guide to the platform, but rather a starting point for understanding the platform and its capabilities. Where appropriate, links to more detailed documentation are provided.
Platform Components
The platform is comprised of a number of components, identifiable by the purple tinted elements in this typical deployment diagram:
The platform components are:
- Business Studio The One37 Studio is the management interface for the platform. It provides a web-based interface for managing the platform, including creating and managing Business Connector instances and workflows.
- Config Manager The Config Manager is a service that is responsible for managing the configuration of the Business Connector. It is a separate service that is deployed alongside the Business Connector.
- Business Connector The One37 Business Connector is the main application that provides the core functionality of the platform. It is responsible for issuing, holding, and verifying verifiable credentials, as well as resolving DIDs and revoking credentials. Multiple Business Connectors can be managed by a single Studio instance.
- Workflow Engine The Workflow Engine is used to independently execute the workflows that are defined or created in the Studio.
- Identity Wallet The Identity Wallet is used to store the credentials for users of the platform. One37 provides its own an advanced capability implementation, the Upa! Identity Wallet, and also a software SDK for React-Native based developers to integrate this functionality into their own mobile applications.
- Marketplace The Marketplace is a optional discovery service where your business and other eco-systems partners can publish their services and workflows for others to discover and use. The Marketplace component is not covered in this guide.
TL;DR Get Started
Assuming you have the neccessary host, database and networking infrastructure in place, you can get the One37 Platform up and running in just a few steps:
It will greatly smooth the process if you spend a little time planning and documenting the various network hostnames, both public and private, and the respective ports that each service will be using.
A simple checklist document is available in Appendix A to help you with this.
In the rest of this guide we may reference the platform components by their abbreviated names, as follows:
- 'Studio' for Business Studio
- 'CM' for Config Manager
- 'BC' for Business Connector
- 'WE' for Workflow Engine
- 'Wallet' for Identity Wallet
Steps
- System Prerequisites
- Configure the Business Studio launch parameters and start it up.
- Access the Web UI and configure the Super Admin user.
- Configure the Business Connector launch parameters and start it up.
- Configure the Config Manager launch parameters and start it up.
- Configure the Workflow Engine launch parameters and start it up.
- Create a Business in the Studio, following the setup wizard.
- Verify that all components are running and communicating correctly.
Lets get started!