{"id":21214466,"url":"https://github.com/slice/peek","last_synced_at":"2025-07-02T20:36:52.118Z","repository":{"id":83250367,"uuid":"277491792","full_name":"slice/peek","owner":"slice","description":"An optionally dynamic landing page for your servers","archived":false,"fork":false,"pushed_at":"2020-07-06T19:15:53.000Z","size":53,"stargazers_count":12,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-05T12:51:08.683Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/slice.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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}},"created_at":"2020-07-06T08:56:16.000Z","updated_at":"2024-06-27T11:25:04.000Z","dependencies_parsed_at":"2023-03-20T08:47:48.391Z","dependency_job_id":null,"html_url":"https://github.com/slice/peek","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/slice/peek","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slice%2Fpeek","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slice%2Fpeek/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slice%2Fpeek/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slice%2Fpeek/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/slice","download_url":"https://codeload.github.com/slice/peek/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slice%2Fpeek/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263212113,"owners_count":23431447,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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-20T21:28:01.844Z","updated_at":"2025-07-02T20:36:52.109Z","avatar_url":"https://github.com/slice.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# peek\n\n![Screenshot of peek](https://i.imgur.com/egsi0Qc.png)\n\npeek is a minimal landing page for your servers that can optionally act as a\nminiature dashboard.\n\nTo get started, clone the website somewhere:\n\n```sh\ngit clone https://github.com/slice/peek.git\n```\n\nThen, edit `index.html` and replace the `\u003ch1\u003e` and `\u003ctitle\u003e` text with the name\nof your server or network. If you just want a static landing page, then you're\ndone!\n\n## Dashboard usage\n\nYou can optionally expose a JSON endpoint (or file) that the website can fetch\nto present a list of meters, links, or both. We'll call this the dashboard.\n\nBy default, the website is static and fully functional with JavaScript disabled.\nTo enable the dashboard, change `DYNAMIC` from `false` to `true` in the\n`\u003cscript\u003e` tag in `index.html`:\n\n```js\nwindow.DYNAMIC = true;\nwindow.DYNAMIC_JSON_ENDPOINT = \"//dynamic.example.json\";\n```\n\n`DYNAMIC_JSON_ENDPOINT` is the URL to the JSON that the website will fetch on\nload. If you want to load JSON from a different domain, make sure that you have\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) configured\ncorrectly.\n\n(If the endpoint starts with `//`, then the `//` will be replaced with the\ndomain that the page is loaded at, even matching the protocol.)\n\n### Example\n\nHere is a commentated example of the JSON the server can respond with. Keep in\nmind that JSON doesn't actually support comments, so you'll need to remove them\nif you copy this.\n\n```js\n{\n  // The link list. You can remove this entirely if you'd like.\n  \"links\": [\n    // A plain link.\n    { \"url\": \"https://github.com\" },\n    // A link with custom text.\n    { \"url\": \"https://gitlab.com\", \"text\": \"GitLab\" },\n    // A link with custom text that opens in a new tab.\n    { \"url\": \"https://grafana.com\", \"text\": \"Grafana\", \"new_tab\": true }\n  ],\n\n  // The meter display. Again, you can remove this entirely if you'd like.\n  \"meters\": [\n    // A meter. The minimum value is zero (this cannot be changed).\n    { \"value\": 25, \"max\": 50, \"label\": \"Apples\" },\n    // A meter with a unit.\n    { \"value\": 250, \"max\": 1000, \"label\": \"Storage\", \"unit\": \"GB\" },\n    // A meter that omits the maximum value. You can also hide the value\n    // altogether with `\"showValue\": false`.\n    { \"value\": 75, \"label\": \"Bandwidth\", \"unit\": \"TB\", \"showMax\": false }\n  ]\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslice%2Fpeek","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslice%2Fpeek","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslice%2Fpeek/lists"}