{"id":13821801,"url":"https://github.com/GeorgeGedox/HomerGX","last_synced_at":"2025-05-16T15:31:01.124Z","repository":{"id":53209891,"uuid":"419037195","full_name":"GeorgeGedox/HomerGX","owner":"GeorgeGedox","description":"A custom fork of Homer, improved and with a new design.","archived":false,"fork":false,"pushed_at":"2022-02-02T14:50:13.000Z","size":10005,"stargazers_count":81,"open_issues_count":1,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-06-28T07:32:16.808Z","etag":null,"topics":["dashboard","docker","foss","homepage","homer","self-hosted"],"latest_commit_sha":null,"homepage":"https://homergx-demo.netlify.app/","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GeorgeGedox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-10-19T18:00:59.000Z","updated_at":"2024-06-24T21:35:55.000Z","dependencies_parsed_at":"2022-09-15T06:20:43.316Z","dependency_job_id":null,"html_url":"https://github.com/GeorgeGedox/HomerGX","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeorgeGedox%2FHomerGX","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeorgeGedox%2FHomerGX/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeorgeGedox%2FHomerGX/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeorgeGedox%2FHomerGX/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GeorgeGedox","download_url":"https://codeload.github.com/GeorgeGedox/HomerGX/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":213893315,"owners_count":15653524,"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":["dashboard","docker","foss","homepage","homer","self-hosted"],"created_at":"2024-08-04T08:01:28.938Z","updated_at":"2024-08-04T08:07:05.276Z","avatar_url":"https://github.com/GeorgeGedox.png","language":"Vue","funding_links":[],"categories":["Vue"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n \u003cimg\n  width=\"120\"\n  alt=\"HomerGX\"\n  src=\"https://raw.githubusercontent.com/GeorgeGedox/HomerGX/master/public/logo.png\"\u003e\n    \u003cbr/\u003e\n    HomerGX\n\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003e\n    \u003ca href=\"https://homergx-demo.netlify.app/\"\u003eDemo\u003c/a\u003e\n    |\n    \u003ca href=\"https://github.com/GeorgeGedox/HomerGX/pkgs/container/homergx\"\u003eDocker image\u003c/a\u003e\n    |\n    \u003ca href=\"#getting-started\"\u003eGetting started\u003c/a\u003e\n  \u003c/strong\u003e\n\u003c/p\u003e\n\nLight Mode             |  Dark Mode\n:-------------------------:|:-------------------------:\n![](https://raw.githubusercontent.com/GeorgeGedox/HomerGX/master/docs/screenshot-light.png)  |  ![](https://raw.githubusercontent.com/GeorgeGedox/HomerGX/master/docs/screenshot-dark.png)\n\n![Build status](https://img.shields.io/github/workflow/status/georgegedox/homergx/Create%20Release)\n![GitHub Workflow Status](https://img.shields.io/github/workflow/status/georgegedox/homergx/Lint?label=lint)\n![GitHub](https://img.shields.io/github/license/georgegedox/homergx)\n![Netlify](https://img.shields.io/netlify/423ddc71-a623-49be-aec3-3bef054b2c79)\n\n## Table of Contents\n- [Features over the original](#features)\n- [Getting started](#getting-started)\n- [Configuration](docs/configuration.md)\n- [Custom services](docs/customservices.md)\n- [Tips \u0026 tricks](docs/tips-and-tricks.md)\n- [Development](docs/development.md)\n- [Troubleshooting](docs/troubleshooting.md)\n\n## Features over the original\nThe project was forked at version `v21.09.2`, some of the things below might not hold true anymore\n\n- Cleaner code\n- Color mode can be forced(light/dark/auto) and the button can be hidden\n- Layout can be forced vertical/horizontal and the button can be hidden\n- Search can be disabled\n- Modern theme already bundled in\n\n### Planned features\n- More services\n- More bundled themes\n\n## Getting started\n\nHomerGX is a full static html/js dashboard, generated from the source in `/src` using webpack. It's meant to be served by an HTTP server, **it will not work if you open dist/index.html directly over file:// protocol**.\n\nSee [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options.\n\n### Using docker\n\nTo launch container:\n\n```sh\ndocker run -d -p 8080:8080 -v \u003c/your/local/assets/\u003e:/www/assets --restart=always ghcr.io/georgegedox/homergx:latest\n```\n\nDefault assets will be automatically installed in the `/www/assets` directory. Use `UID` and/or `GID` env var to change the assets owner (`docker run -e \"UID=1000\" -e \"GID=1000\" [...]`).\n\n### Using docker-compose\n\nThe `docker-compose.yml` file must be edited to match your needs.\nSet the port and volume (equivalent to `-p` and `-v` arguments):\n\n```yaml\nvolumes:\n  - /your/local/assets/:/www/assets\nports:\n  - 8080:8080\n```\n\nTo launch container:\n\n```sh\ncd /path/to/docker-compose.yml\ndocker-compose up -d\n```\n\nDefault assets will be automatically installed in the `/www/assets` directory. Use `UID` and/or `GID` env var to change the assets owner, also in `docker-compose.yml`:\n\n```yaml\nenvironment:\n  - UID=1000\n  - GID=1000\n```\n\n### Using the release zip (prebuilt, ready to use)\n\nDownload and extract the latest release (`homergx.zip`) from the [release page](https://github.com/GeorgeGedox/HomerGX/releases), rename the `assets/config.yml.dist` file to `assets/config.yml`, and put it on a web server.\n\n```sh\nwget https://github.com/GeorgeGedox/HomerGX/releases/latest/download/homergx.zip\nunzip homer.zip\ncd homer\ncp assets/config.yml.dist assets/config.yml\nnpx serve # or python -m http.server 8010 or apache, nginx ...\n```\n\n### Build manually\n\n```sh\n# Using npm\nnpm install\nnpm run build\n```\n\nYour dashboard is now ready for use in the `/dist` directory.\n\n## Credits\n- Original code and assets by the [Homer](https://github.com/bastienwirtz/homer) project team and it's contributors\n- Background images from [Unsplash](https://unsplash.com) content creators [Richard Horvath](https://unsplash.com/@orwhat), [SIMON LEE](https://unsplash.com/@simonppt), [Voicu Apostol](https://unsplash.com/@cerpow)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGeorgeGedox%2FHomerGX","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FGeorgeGedox%2FHomerGX","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGeorgeGedox%2FHomerGX/lists"}