🏁How to get started
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.
Last updated
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.
Last updated
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.
Log in with your Admin credentials.
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.
Choose your tenant purpose (e.g., production, sandbox) and set configurations like Tenant Name and Network Selection (Testnet, Mainnet, or Previewnet).
For storing digital environmental assets, select an IPFS Storage Provider, such as Web 3 Storage.
Enter necessary API Key and API Proof values (refer to documentation for creation instructions).
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.
The first user is typically a Standard Registry account. The Standard Registry user establishes methodology requirements and issues tokens.
Follow on-screen steps to complete the user profile setup, starting with selecting a vault. The Managed Guardian Service Vault is designed to benefit organizations and individuals looking to for a self-custody option to securely store their user account secrets, such as private keys. Please refer to our MGS Vault documentation for compatible vaults and guides
Enter Hedera Account ID and Private Key. If you don't have one please visit the Hedera Developer Portal and create the Account ID and Private Key. Please remember that when getting your Hedera ID and Private Key from the Hedera Developer Portal, the Managed Guardian Service uses "ED25519" keys. Please ignore "ECDSA" key options.
Additionally, for the Private Key, you will need to use the "DER Encoded" Private Key and not the "HEX Encoded" Private Key.
Next, you'll need to set up your digital identity. You can let MGS create a new DID document for you, or if you have an existing one, you can select the "Bring Your Own DID" option. If you are bringing your own DID, you will need to also enter the DID Keys.
Fill out the company profile for visibility in the standard registry Hedera topic.
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.
Use Dry Run mode to test policies in a simulated environment. Create virtual users and interact with policies as real-world users would.
Publish your policies for interaction by Policy users.
Invite policy users to your tenant to submit data and engage with published policies.
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.
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.
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/