{"id":13433608,"url":"https://github.com/gethomepage/homepage","last_synced_at":"2025-05-13T15:02:28.181Z","repository":{"id":57887768,"uuid":"528313152","full_name":"gethomepage/homepage","owner":"gethomepage","description":"A highly customizable homepage (or startpage / application dashboard) with Docker and service API integrations.","archived":false,"fork":false,"pushed_at":"2025-04-30T00:34:15.000Z","size":51427,"stargazers_count":23382,"open_issues_count":1,"forks_count":1427,"subscribers_count":75,"default_branch":"dev","last_synced_at":"2025-04-30T01:30:03.801Z","etag":null,"topics":["docker","homepage","nextjs","node","react","self-hosted","startpage"],"latest_commit_sha":null,"homepage":"https://gethomepage.dev","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gethomepage.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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},"funding":{"github":["gethomepage"],"open_collective":"homepage","patreon":"gethomepage"}},"created_at":"2022-08-24T07:29:42.000Z","updated_at":"2025-04-30T01:26:19.000Z","dependencies_parsed_at":"2023-10-15T13:48:30.910Z","dependency_job_id":"7eee1adb-5af8-4679-beb3-9073b4ae3bb9","html_url":"https://github.com/gethomepage/homepage","commit_stats":{"total_commits":6041,"total_committers":404,"mean_commits":"14.952970297029703","dds":"0.36351597417646087","last_synced_commit":"6fd2b6b6dc990368bb83b8625fc66856e699a604"},"previous_names":["gethomepage/homepage","benphelps/homepage"],"tags_count":128,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gethomepage%2Fhomepage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gethomepage%2Fhomepage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gethomepage%2Fhomepage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gethomepage%2Fhomepage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gethomepage","download_url":"https://codeload.github.com/gethomepage/homepage/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251699776,"owners_count":21629825,"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":["docker","homepage","nextjs","node","react","self-hosted","startpage"],"created_at":"2024-07-31T02:01:30.701Z","updated_at":"2025-05-05T18:10:26.043Z","avatar_url":"https://github.com/gethomepage.png","language":"JavaScript","funding_links":["https://github.com/sponsors/gethomepage","https://opencollective.com/homepage","https://patreon.com/gethomepage","https://paypal.me/phelpsben"],"categories":["JavaScript","Apps","Productivity","Software","HarmonyOS","Projects","docker","self-hosted","Table of Contents","Dashboards","Monitor"],"sub_categories":["Dashboard","Personal Dashboards","Windows Manager","Hosted"],"readme":"\u003cp align=\"center\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"images/banner_light@2x.png\"\u003e\n    \u003cimg src=\"images/banner_dark@2x.png\" width=\"65%\"\u003e\n  \u003c/picture\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  A modern, \u003cem\u003efully static, fast\u003c/em\u003e, secure \u003cem\u003efully proxied\u003c/em\u003e, highly customizable application dashboard with integrations for over 100 services and translations into multiple languages. Easily configured via YAML files or through docker label discovery.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"images/1.png?v=2\" /\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/gethomepage/homepage/actions/workflows/docker-publish.yml\"\u003e\u003cimg alt=\"GitHub Workflow Status (with event)\" src=\"https://img.shields.io/github/actions/workflow/status/gethomepage/homepage/docker-publish.yml\"\u003e\u003c/a\u003e\n  \u0026nbsp;\n  \u003ca href=\"https://crowdin.com/project/gethomepage\" target=\"_blank\"\u003e\u003cimg src=\"https://badges.crowdin.net/gethomepage/localized.svg\"\u003e\u003c/a\u003e\n  \u0026nbsp;\n  \u003ca href=\"https://discord.gg/k4ruYNrudu\"\u003e\u003cimg alt=\"Discord\" src=\"https://img.shields.io/discord/1019316731635834932\"\u003e\u003c/a\u003e\n  \u0026nbsp;\n  \u003ca href=\"https://gethomepage.dev/\" title=\"Docs\"\u003e\u003cimg title=\"Docs\" src=\"https://github.com/gethomepage/homepage/actions/workflows/docs-publish.yml/badge.svg\"/\u003e\u003c/a\u003e\n  \u0026nbsp;\n  \u003ca href=\"https://paypal.me/phelpsben\" title=\"Donate\"\u003e\u003cimg alt=\"GitHub Sponsors\" src=\"https://img.shields.io/github/sponsors/benphelps\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.digitalocean.com/?refcode=df14bcb7c016\u0026utm_campaign=Referral_Invite\u0026utm_medium=Referral_Program\u0026utm_source=badge\"\u003e\u003cimg src=\"https://web-platforms.sfo2.cdn.digitaloceanspaces.com/WWW/Badge%201.svg\" alt=\"DigitalOcean Referral Badge\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n\u003cem\u003eHomepage builds are kindly powered by DigitalOcean.\u003c/em\u003e\n\u003c/p\u003e\n\n# Features\n\nWith features like quick search, bookmarks, weather support, a wide range of integrations and widgets, an elegant and modern design, and a focus on performance, Homepage is your ideal start to the day and a handy companion throughout it.\n\n- **Fast** - The site is statically generated at build time for instant load times.\n- **Secure** - All API requests to backend services are proxied, keeping your API keys hidden. Constantly reviewed for security by the community.\n- **For Everyone** - Images built for AMD64, ARM64.\n- **Full i18n** - Support for over 40 languages.\n- **Service \u0026 Web Bookmarks** - Add custom links to the homepage.\n- **Docker Integration** - Container status and stats. Automatic service discovery via labels.\n- **Service Integration** - Over 100 service integrations, including popular starr and self-hosted apps.\n- **Information \u0026 Utility Widgets** - Weather, time, date, search, and more.\n- **And much more...**\n\n## Docker Integration\n\nHomepage has built-in support for Docker, and can automatically discover and add services to the homepage based on labels. See the [Docker Service Discovery](https://gethomepage.dev/configs/docker/#automatic-service-discovery) page for more information.\n\n## Service Widgets\n\nHomepage also has support for hundreds of 3rd-party services, including all popular \\*arr apps, and most popular self-hosted apps. Some examples include: Radarr, Sonarr, Lidarr, Bazarr, Ombi, Tautulli, Plex, Jellyfin, Emby, Transmission, qBittorrent, Deluge, Jackett, NZBGet, SABnzbd, etc. As well as service integrations, Homepage also has a number of information providers, sourcing information from a variety of external 3rd-party APIs. See the [Service](https://gethomepage.dev/widgets/) page for more information.\n\n## Information Widgets\n\nHomepage has built-in support for a number of information providers, including weather, time, date, search, glances and more. System and status information presented at the top of the page. See the [Information Providers](https://gethomepage.dev/widgets/) page for more information.\n\n## Customization\n\nHomepage is highly customizable, with support for custom themes, custom CSS \u0026 JS, custom layouts, formatting, localization and more. See the [Settings](https://gethomepage.dev/configs/settings/) page for more information.\n\n# Getting Started\n\nFor configuration options, examples and more, [please check out the homepage documentation](http://gethomepage.dev).\n\n## Security Notice 🔒\n\nPlease note that when using features such as widgets, Homepage can access personal information (for example from your home automation system) and Homepage currently does not (and is not planned to) include any authentication layer itself. Thus, we recommend homepage be deployed behind a reverse proxy including authentication, SSL etc, and / or behind a VPN.\n\n## With Docker\n\nUsing docker compose:\n\n```yaml\nservices:\n  homepage:\n    image: ghcr.io/gethomepage/homepage:latest\n    container_name: homepage\n    environment:\n      HOMEPAGE_ALLOWED_HOSTS: gethomepage.dev # required, may need port. See gethomepage.dev/installation/#homepage_allowed_hosts\n      PUID: 1000 # optional, your user id\n      PGID: 1000 # optional, your group id\n    ports:\n      - 3000:3000\n    volumes:\n      - /path/to/config:/app/config # Make sure your local config directory exists\n      - /var/run/docker.sock:/var/run/docker.sock:ro # optional, for docker integrations\n    restart: unless-stopped\n```\n\nor docker run:\n\n```bash\ndocker run --name homepage \\\n  -e HOMEPAGE_ALLOWED_HOSTS=gethomepage.dev \\\n  -e PUID=1000 \\\n  -e PGID=1000 \\\n  -p 3000:3000 \\\n  -v /path/to/config:/app/config \\\n  -v /var/run/docker.sock:/var/run/docker.sock:ro \\\n  --restart unless-stopped \\\n  ghcr.io/gethomepage/homepage:latest\n```\n\n## From Source\n\nFirst, clone the repository:\n\n```bash\ngit clone https://github.com/gethomepage/homepage.git\n```\n\nThen install dependencies and build the production bundle:\n\n```bash\npnpm install\npnpm build\n```\n\nIf this is your first time starting, copy the `src/skeleton` directory to `config/` to populate initial example config files.\n\nFinally, run the server in production mode:\n\n```bash\npnpm start\n```\n\n# Configuration\n\nPlease refer to the [homepage documentation website](https://gethomepage.dev/) for more information. Everything you need to know about configuring Homepage is there. Please read everything carefully before asking for help, as most questions are answered there or are simple YAML configuration issues.\n\n# Development\n\nInstall NPM packages, this project uses [pnpm](https://pnpm.io/) (and so should you!):\n\n```bash\npnpm install\n```\n\nStart the development server:\n\n```bash\npnpm dev\n```\n\nOpen [http://localhost:3000](http://localhost:3000) to start.\n\nThis is a [Next.js](https://nextjs.org/) application, see their documentation for more information.\n\n# Documentation\n\nThe homepage documentation is available at [https://gethomepage.dev/](https://gethomepage.dev/).\n\nHomepage uses Material for MkDocs for documentation. To run the documentation locally, first install the dependencies:\n\n```bash\npip install -r requirements.txt\n```\n\nThen run the development server:\n\n```bash\nmkdocs serve # or build, to build the static site\n```\n\n# Support \u0026 Suggestions\n\nIf you have any questions, suggestions, or general issues, please start a discussion on the [Discussions](https://github.com/gethomepage/homepage/discussions) page.\n\n## Troubleshooting\n\nIn addition to the docs, the [troubleshooting guide](https://gethomepage.dev/troubleshooting/) can help reveal many basic config or network issues. If you're having a problem, it's a good place to start.\n\n## Contributing \u0026 Contributors\n\nContributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.\n\nThanks to the over 200 contributors who have helped make this project what it is today!\n\nEspecially huge thanks to [@shamoon](https://github.com/shamoon), who has been the backbone of this community from the very start.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgethomepage%2Fhomepage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgethomepage%2Fhomepage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgethomepage%2Fhomepage/lists"}