{"id":20131340,"url":"https://github.com/qzed/dashboard","last_synced_at":"2026-06-05T06:31:33.069Z","repository":{"id":207044791,"uuid":"718283985","full_name":"qzed/dashboard","owner":"qzed","description":"Basic homelab dashboard","archived":false,"fork":false,"pushed_at":"2023-11-15T22:03:59.000Z","size":138,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-02T21:44:35.429Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qzed.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-11-13T19:10:08.000Z","updated_at":"2024-04-06T18:25:51.000Z","dependencies_parsed_at":"2023-11-15T23:23:50.789Z","dependency_job_id":"d7f0748a-99a0-4090-aead-93b401fc3f7c","html_url":"https://github.com/qzed/dashboard","commit_stats":null,"previous_names":["qzed/dashboard"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/qzed/dashboard","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qzed%2Fdashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qzed%2Fdashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qzed%2Fdashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qzed%2Fdashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qzed","download_url":"https://codeload.github.com/qzed/dashboard/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qzed%2Fdashboard/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33932048,"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-06-05T02:00:06.157Z","response_time":120,"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":[],"created_at":"2024-11-13T20:47:44.000Z","updated_at":"2026-06-05T06:31:33.050Z","avatar_url":"https://github.com/qzed.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dashboard\n\nA very basic homelab dashboard, allowing you to display links to all your services on one simple page.\nConfigured via yaml.\nNo fancy stuff, no other extras.\n\n## Preview\n\n![Screenshot of dashboard](.assets/page.png)\n\n## Instructions\n\n### Pre-built Docker container\n\nA pre-built docker container is available at `ghcr.io/qzed/dashboard:latest`.\nYou can pull and run it via\n```\ndocker container run --rm \\\n    -p 80:3000/tcp \\\n    --mount type=bind,source=$CONFIG_DIR,destination=/app/data \\\n    localhost/dashboard:latest\n```\nChange the port mapping and mount options to your needs and replace `$CONFIG_DIR` with a path to the configuration directory containing the `apps.yaml` file.\n\nTo test it, you can set `$CONFIG_DIR` to the [`data`](data) directory of this repository.\nThis contains an example app configuration file ([`data/apps.yaml`](data/apps.yaml)), that you can copy and adapt to your setup.\nSee [below](#configuration) for more details on how to configure the dashboard.\n\n\u003cdetails\u003e\n\u003csummary\u003eExample pod specification\u003c/summary\u003e\n\n```yaml\napiVersion: v1\nkind: Pod\n\nmetadata:\n  name: dashboard\n  labels:\n    app: dashboard\n\nspec:\n  containers:\n  - name: dashboard\n    image: ghcr.io/qzed/dashboard:latest\n\n    ports:\n    - containerPort: 3000\n      hostPort: 80\n      protocol: tcp\n\n    volumeMounts:\n    - name: data\n      mountPath: /app/data\n\n  volumes:\n  - name: data\n    hostPath:\n      path: /srv/containers/dashboard/data\n      type: Directory\n```\n\n\u003c/details\u003e\n\n### Build and run via Docker\n\nBuild the container with\n```\ndocker build -f Dockerfile -t dashboard\n```\nthen run it via\n```\ndocker container run --rm \\\n    -p 80:3000/tcp \\\n    --mount type=bind,source=$PWD/data,destination=/app/data \\\n    localhost/dashboard:latest\n```\nChange the port mapping and mount options to your needs.\nWhen running via Docker, the app runs in `/app` and expects the `apps.yaml` configuration file at `/app/data/apps.yaml`.\n\n### Build and run from source (without Docker)\n\nTo build and run from source, run\n```\nyarn install\nyarn build\nyarn run\n```\nTo debug and develop, run\n```\nyarn dev\n```\n\n## Configuration\n\nThe list of displayed applications/services is placed at `$CWD/data/apps.yaml`, where `$CWD` indicates the current working directory of the server process.\nAn example configuration that will be used when you run with the above example commands (as-is) can be found at `data/apps.yaml`.\n\nEach app entry can be configured via the following properties:\n- `name`: Main display name\n- `text`: Smaller additional text (this could, for example, display the URL)\n- `url`: The URL to link to\n- `icon`: The icon to display. A list of supported icon names can be found [here](https://marella.me/material-symbols/demo/#rounded).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqzed%2Fdashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqzed%2Fdashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqzed%2Fdashboard/lists"}