{"id":50418236,"url":"https://github.com/chriscorbell/orbitdash","last_synced_at":"2026-05-31T07:02:33.812Z","repository":{"id":338690728,"uuid":"1158260352","full_name":"chriscorbell/orbitdash","owner":"chriscorbell","description":"yet another modern server dashboard","archived":false,"fork":false,"pushed_at":"2026-05-16T03:32:27.000Z","size":1716,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-16T05:32:30.656Z","etag":null,"topics":["dashboard","docker","docker-compose","homelab","self-hosted","server"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chriscorbell.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-02-15T03:49:32.000Z","updated_at":"2026-05-16T03:29:05.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/chriscorbell/orbitdash","commit_stats":null,"previous_names":["chriscorbell/orbitdash"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/chriscorbell/orbitdash","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chriscorbell%2Forbitdash","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chriscorbell%2Forbitdash/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chriscorbell%2Forbitdash/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chriscorbell%2Forbitdash/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chriscorbell","download_url":"https://codeload.github.com/chriscorbell/orbitdash/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chriscorbell%2Forbitdash/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33722156,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-31T02:00:06.040Z","response_time":95,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dashboard","docker","docker-compose","homelab","self-hosted","server"],"created_at":"2026-05-31T07:02:33.727Z","updated_at":"2026-05-31T07:02:33.806Z","avatar_url":"https://github.com/chriscorbell.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\".github/images/logo.svg\" alt=\"orbitdash - yet another modern server dashboard\" width=\"320\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/chriscorbell/orbitdash/actions/workflows/docker-publish.yml?branch=main\" target=\"_blank\"\u003e\n    \u003cimg title=\"GitHub Actions\" src=\"https://github.com/chriscorbell/orbitdash/actions/workflows/docker-publish.yml/badge.svg?branch=main\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cbr/\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cb\u003eorbitdash\u003c/b\u003e is \u003ci\u003eyet another\u003c/i\u003e modern server dashboard, \u003cbr\u003einspired by \u003ca href=\"https://github.com/MauriceNino/dashdot\" target=\"_blank\"\u003edashdot\u003c/a\u003e, \u003ca href=\"https://github.com/bastienwirtz/homer\" target=\"_blank\"\u003ehomer\u003c/a\u003e and \u003ca href=\"https://github.com/ajnart/homarr\" target=\"_blank\"\u003ehomarr\u003c/a\u003e.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  It is intended for use on home/private servers.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  Built with TypeScript, React, TailwindCSS, shadcn/ui, Vite, Bun, Hono and SQLite.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/chriscorbell/orbitdash/pkgs/container/orbitdash\" target=\"_blank\"\u003eContainer Image (GHCR)\u003c/a\u003e\n\u003c/p\u003e\n\n## Preview\n\n\u003cimg src=\".github/images/preview.png\" alt=\"Screenshot of the app\" /\u003e\n\n## Features\n\n- Live CPU/RAM/Disk metrics with charts\n- Simple service links with icons and categories\n- Upload your own PNG/SVG icons, or alternatively enter a direct URL to a PNG or SVG icon\n- Inline search and filtering\n- UI-native service management (no config file needed)\n- Toggle between 3-column and 4-column grid for service links\n- Reorder category sections with a shared saved layout\n\n## Platform Support\n\n- x86_64\n- aarch64\n\n## Installation Options\n\n#### Docker Run\n\n```bash\ndocker run -d \\\n  --name orbitdash \\\n  --restart unless-stopped \\\n  -p 7770:3000 \\\n  -v ./orbitdash-data:/data \\\n  ghcr.io/chriscorbell/orbitdash:latest\n```\n\n#### Docker Compose\n\n```yaml\nservices:\n  orbitdash:\n    container_name: orbitdash\n    image: ghcr.io/chriscorbell/orbitdash:latest\n    restart: unless-stopped\n    ports:\n      - \"7770:3000\"\n    volumes:\n      - ./orbitdash-data:/data\n```\n\nAfter deployment, the dashboard is accessible at `http://\u003cIP-ADDRESS\u003e:7770`.\n\nChange `7770` in the docker run/compose examples above if you want to serve the dashboard on a different port.\n\n## Data Persistence\n\nAll data is stored under `/data` inside the container:\n\n- `orbitdash.db` (SQLite database)\n- `icons/` (uploaded/downloaded service icons)\n\nThe docker run/compose examples above bind-mount `/data` to `./orbitdash-data` in the current working host directory. You can change this to a different location on the host, or alternatively map to a volume instead if desired.\n\nOutside Docker, orbitdash stores data in `./data` by default. You can override the storage path in any environment with `ORBITDASH_DATA_DIR=/path/to/data`.\n\nFor backup and restore steps, including SQLite WAL files and icon assets, see\n[docs/backup-restore.md](docs/backup-restore.md).\n\nThe backend listens on port `3001` by default outside the container. Override it with `PORT=\u003cport\u003e`.\n\nThe disk metric uses `/` by default. Override it with `ORBITDASH_DISK_PATH=/path/to/mount` when you\nneed to track a different mount.\n\n## Health Checks\n\n- `GET /healthz` returns liveness for process-level checks.\n- `GET /readyz` returns readiness for deployment and CI probes, including a SQLite connectivity check.\n- `GET /api/health` returns the same readiness payload as `readyz` for API-oriented clients.\n\n## Deployment Verification\n\nAfter deploying or upgrading the container, verify the service with:\n\n```bash\ncurl --fail http://127.0.0.1:7770/healthz\ncurl --fail http://127.0.0.1:7770/readyz\n```\n\nAlso confirm that:\n\n- the host directory or volume mapped to `/data` is intact\n- the expected host port is mapped to container port `3000`\n- persisted services and icons still load after the restart\n\n## Testing\n\nUse the following commands for the initial automated test workflow:\n\n```bash\nnpm run test:e2e:install\nnpm run format\nnpm run format:check\nnpm run typecheck\nnpm run test:unit\nnpm run test:integration\nnpm run test:e2e\nnpm test -- --run\nnpm run test:coverage\n```\n\nRun `npm run test:e2e:install` once per machine before the first browser smoke test so Chromium is\navailable locally.\n\nFormatting is enforced with Prettier. Use `npm run format` locally to normalize files and\n`npm run format:check` to run the same check that CI uses.\n\nThe enforced coverage gate currently applies to shared runtime modules under `shared/` excluding\ntype-only definitions in `shared/types.ts`. Expand that coverage scope as backend, hook, component,\nand end-to-end suites are added.\n\n## Validation Rules\n\nShared runtime validation now lives in `shared/schemas.ts` and is used by both the server routes\nand the service dialog submit path. The current canonical rules are:\n\n- service names are required after trimming\n- service URLs must normalize to valid `http` or `https` URLs\n- icon URLs, when provided, must normalize to valid `http` or `https` URLs\n- remote icon downloads are limited to 2 MB, time out after 5 seconds, follow at most 3 redirects,\n  reject localhost/private literal hosts, and verify the downloaded bytes match a supported image\n  format\n- category and description fields are trimmed and normalized to `null` when empty\n- the `Uncategorized` section cannot be manually included in saved category ordering\n- metrics `window` must be a positive integer and is bounded to 3600 seconds\n\n## Contributing\n\nIssues and PRs are welcomed. Please include description, screenshots and any related logs.\n\nFor local workflows and project conventions, see [CONTRIBUTING.md](CONTRIBUTING.md),\n[docs/architecture.md](docs/architecture.md), and [docs/release-checklist.md](docs/release-checklist.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchriscorbell%2Forbitdash","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchriscorbell%2Forbitdash","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchriscorbell%2Forbitdash/lists"}