Superdesktop — Resources

Guides, deployment recipes, API references, security and troubleshooting for Superdesktop.

Official Documentation

Project README

Canonical overview, modules, quick start and architecture summary.

Open README on GitHub

Architecture Docs

In-depth architecture, service diagrams and deployment topologies.

Open architecture docs

Deployment & Ops

Quick Deploy (dev/demo)

Use the included Docker Compose for a local demo and smoke tests.

git clone https://github.com/Chandu00756/Superdesktop.git cd Superdesktop chmod +x start-omega.sh ./start-omega.sh

Production Patterns

Kubernetes operator, multi-zone deployments, secrets management and HA considerations. See docs for operator manifests and Helm charts.

Deployment manifests & Helm

API & CLI

API Reference

OpenAPI docs live at /docs when services are running. Key endpoints: /health, /sessions, /nodes.

CLI & Utilities

Helper scripts for local development and utilities for backup/restore are available in the repo tools folder.

Troubleshooting & FAQ

Common startup failures

If ports are in use, check docker-compose logs and free common ports (8081, 8443). For TLS issues, ensure certificates are properly mounted and file permissions are correct.

Database connectivity

Superdesktop supports Postgres (recommended). For dev mode SQLite fallback may be used; consult the docs for migration commands.

Performance tuning

Capacity planning, GPU passthrough and NUMA-aware scheduling are covered in the performance tuning guide in docs.

Contributing & Governance

Please read CONTRIBUTING.md and CODE_OF_CONDUCT.md. The project follows a PR-based workflow with CI checks and code review; tests run with GitHub Actions.

For enterprise support or licensing questions contact chandu@portalvii.com.

Open-source license

Superdesktop is licensed under GPL-3.0 in the repository. Review LICENSE.md for obligations and distribution terms.