Getting Started
Last updated
Was this helpful?
The Guardian is an open-source platform that streamlines the creation, management, and verification of digital environmental assets. It leverages a customizable Policy Workflow Engine and Web3 technology to ensure transparent and fraud-proof operations, making it a key tool for transforming sustainability practices & carbon markets.
Below are the universal software prerequisites, followed by network-specific items.
Git – source-control tooling
Docker – one-command build & run (recommended)
MongoDB v6, Node.js v24.15+, and NATS 2.9.25 – auto-provisioned when using Docker Compose
IPFS storage (choose one):
Storacha account – IPFS pinning service (formerly Web3.Storage)
Filebase account – S3-compatible IPFS pinning
Local IPFS node (e.g., Kubo) – auto-provisioned when using Docker Compose
Valkey – in-memory cache & message broker (auto-provisioned by the Docker stack)
Key type
ED25519
ED25519
Network
testnet
mainnet
Fees: Mainnet operations incur HBAR costs—fund your account before running Guardian.
Install a Hedera-enabled wallet (e.g., HashPack).
Create a Mainnet account and note the Account ID (0.0.x).
Export the ED25519 key pair
HashPack path: Settings → Manage Accounts → Export Private Key (DER format).
Update your .env
Create a Testnet account via the Hedera Developer Portal.
Record your Account ID (0.0.x).
Download the ED25519 private key (ignore ECDSA)
Select DER Encoded — do not choose HEX Encoded.
Update your .env
Docker-Compose
(Detects Testnet/Mainnet from .env)
Pre-built containers — pull hashgraph/guardian:latest and supply .env as a secret.
Manual build — clone repo, install Node deps, compile, start services.
Server not starting? Ensure that Docker is running and all containers are up.
Cannot access the admin dashboard? Check if the correct ports (3000) are open and not blocked by your firewall.
Issues with API calls? Verify that your Hedera account ID and private key are correctly configured in the .env file.
For additional help, visit the Hedera Guardian GitHub Issues.
Please send feedback, feature, and support requests to guardian-feedback@hashgraph.com
You can also open issues and feature requests in the GitHub repository.
Hedera Guardian is open-source and licensed under the Apache 2.0 License. Please review the LICENSE file for more details.
Last updated
Was this helpful?
Was this helpful?
HEDERA_NET=mainnet
HEDERA_OPERATOR_ID=0.0.123456
HEDERA_OPERATOR_KEY=-----BEGIN PRIVATE KEY----- … -----END PRIVATE KEY-----HEDERA_NET=testnet
HEDERA_OPERATOR_ID=0.0.987654
HEDERA_OPERATOR_KEY=-----BEGIN PRIVATE KEY----- … -----END PRIVATE KEY-----docker compose -f ./deploy/docker-compose.yml --profile all up -d