🌎Quick Start - MGS
Welcome to the "Getting Started" documentation page! Whether you're new to our platform or looking for a refresher, this guide will walk you through the essential steps to kickstart your journey.
Step 1: Sign Up for Tenant Admin Account
Navigate to the MGS website: https://guardianservice.app/
Click on "Sign Up" and enter your username, email, password, and agree to the terms of use.
Access will be automatically granted upon completion.
Step 2: Admin Login and Tenant Configuration
Log in with your Admin Email and Password.
If its a new Admin account then you will be able to do the following:
Access the Tenant Admin screen; configure your subscription under the Subscription tab.
Navigate to the Tenants tab and click "Add New Tenant" for tenant configuration.
Set configurations like Tenant Name, Network Selection (Testnet, Mainnet, or Previewnet) and IPFS Storage Provider (Managed IPFS Node, Filebase, Web3.Storage).
Enter necessary API Key and API Proof values (refer to documentation for creation instructions) in case of Web3. Storage/Filebase.
Or
If its an existing Admin account with different users having same email address, then we will be able to select from list of users (SRs/Users/Tenants).
Step 4: Inviting Users and Customizing Tenant Branding
Use the Users tab to invite new members to your tenant by entering their email address and assigning a role. Select Standard Registry for users who will be managing and publishing registry policies. Choose User for individuals who will interact with the policies published by the registry.
Customize tenant branding with unique names, colors, logos, and background images.
Adjust IPFS Service Providers and modify API keys and proofs as needed.
Step 5: Setting Up a Standard Registry User Account
The first user is typically a Standard Registry account. This user establishes methodology requirements and issues tokens.
Vault Selection
Follow the on-screen instructions to select a vault. The MGS Vault is designed for organizations or individuals seeking a secure, self-custody option for storing account secrets like private keys.
ℹ️ Note: Vault selection is required for Mainnet, but may be skipped when working on Testnet.
Refer to the MGS Vault documentation for compatible vaults and step-by-step setup guides.
Hedera Account Credentials
You’ll need to enter your Hedera Account ID and Private Key.
If you do not have a Hedera account:
For Testnet:
Visit the Hedera Developer Portal.
Create a new Testnet account.
Choose the ED25519 key type — do not select ECDSA.
Download or copy the DER Encoded Private Key — do not use the HEX Encoded format.
For Mainnet:
Use a Hedera-enabled wallet (e.g., HashPack).
Create a Mainnet account and ensure it is funded with HBAR.
Export the ED25519 key in DER Encoded format.
⚠️ Only ED25519 keys in DER format are supported by the Managed Guardian Service.
Digital Identity (DID) Setup
Next, set up your digital identity. You can either:
Allow MGS to create a new DID document for you, or
Select "Bring Your Own DID", in which case you’ll need to input your existing DID keys.
Organization Profile
Fill out your company profile. This information will appear in the Standard Registry Hedera Topic for network visibility.Fill out the company profile for visibility in the standard registry Hedera topic.
Step 6: Exploring Advanced Features
In the side bar, navigate to the Policy tab and the Schemas section to create and manage schemas.
Dive into features like Artifacts, Modules, Policies, Tools, and Tokens.
Learn to create policies from scratch or import them using the Policies tab.
Step 7: Testing Policies with Dry Run Mode
Use Dry Run mode to test policies in a simulated environment. Create virtual users and interact with policies as real-world users would.
Step 8: Publishing and Inviting Policy Users
Publish your policies for interaction by Policy users.
Invite policy users to your tenant to submit data and engage with published policies.
Step 9: Setting Up Policy User Account
Similar to steps 4 and 5, Policy users need to be invited, and will also need to follow the steps to finish setting up their user account. Policy users then engage with the specific Standard Registry and interact with policies.
Step 10: Final Steps for Policy Users
Explore the List of Tokens and Policies tabs to associate with tokens and access published policies.
Use advanced search features for finding relevant policies for MRV activities.
Step 11: Use the MGS Custom GPT Assistant
Feel free to use the Managed Guardian Service custom GPT here. The Managed Guardian Service (MGS) Custom GPT is a specialized AI assistant designed to facilitate users in understanding and utilizing the Managed Guardian Service platform. This tool represents an advanced version of ChatGPT, customized specifically to cater to the needs of users engaging with MGS. It has been meticulously programmed with a comprehensive range of MGS-related documentation, policies, and operational guidelines.
Note: If you are currently using the open-source Guardian APIs, migrating to Managed Guardian Service is really easy!
Simply change the API URL from what you are currently using (i.e. http://localhost:3002/api/v1/) to https://guardianservice.app/api/v1/
Last updated