Solo is a command-line tool for deploying and managing Hedera network nodes and services on Kubernetes. This repository contains the official technical documentation site for Solo, built with Hugo and the Docsy theme.
The documentation covers:
- Simple Setup: Quick start guides for basic Solo deployments
- Advanced Setup: Complex network configurations and custom deployments
- Using Solo: Command reference and operational guides
- Troubleshooting: Common issues and solutions
- Node.js 22+
- Go (for Hugo extended)
- Hugo extended 0.145.0+
-
Install dependencies:
npm install
-
Build the site:
hugo --cleanDestinationDir
-
Preview locally:
hugo server -D --baseURL http://localhost:1313/ --cleanDestinationDir
or simply
hugo serve
Open
http://localhost:1313/in your browser.
We welcome contributions to improve the Solo documentation! Whether you're fixing typos, adding new guides, or improving existing content, here's how to get started:
- New to contributing? Start with our Contributing Guide
- Found an issue? Open an issue or submit a pull request
- Need help? Check our troubleshooting guide
- Technical contributions: See CONTRIBUTING.md for development setup
- Auto-generated content: Documentation is automatically updated from Solo releases via GitHub Actions
content/en/docs/- Main documentation contentcontent/en/docs/simple-solo-setup/- Getting started guidescontent/en/docs/advanced-solo-setup/- Advanced configurationcontent/en/docs/using-solo/- Usage and operationscontent/en/docs/troubleshooting.md- Common issues and solutions
The site is automatically deployed to solo.hiero.org when new Solo releases are published. Manual deployments can be triggered via GitHub Actions.
- Documentation Issues: GitHub Issues
- Solo Tool Issues: Solo Repository
- Community: Check our community contributions guide