This reverts commit
|6 hours ago|
|.devcontainer||8 months ago|
|.github||16 hours ago|
|.vscode||2 months ago|
|docs||16 hours ago|
|images||2 months ago|
|k3d||1 month ago|
|public||1 day ago|
|src||6 hours ago|
|.all-contributorsrc||1 year ago|
|.babelrc||3 days ago|
|.dockerignore||3 months ago|
|.editorconfig||1 year ago|
|.eslintrc.json||1 year ago|
|.gitignore||2 months ago|
|.pre-commit-config.yaml||1 month ago|
|.prettierrc||1 month ago|
|CODE_OF_CONDUCT.md||1 month ago|
|CONTRIBUTING.md||1 month ago|
|Dockerfile||2 months ago|
|Dockerfile-tilt||11 months ago|
|LICENSE||1 year ago|
|README.md||1 month ago|
|crowdin.yml||2 months ago|
|docker-entrypoint.sh||8 months ago|
|jsconfig.json||1 month ago|
|kubernetes.md||1 month ago|
|mkdocs.yml||1 day ago|
|next-i18next.config.js||1 month ago|
|next.config.js||3 days ago|
|package-lock.json||3 days ago|
|package.json||3 days ago|
|pnpm-lock.yaml||3 days ago|
|postcss.config.js||1 month ago|
|requirements.txt||1 month ago|
|tailwind.config.js||4 weeks ago|
A modern, fully static, fast, secure fully proxied, 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.
With 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.
- Fast - The site is statically generated at build time for instant load times.
- Secure - All API requests to backend services are proxied, keeping your API keys hidden. Constantly reviewed for security by the community.
- For Everyone - Images built for AMD64, ARM64, ARMv7, and ARMv6.
- Full i18n - Support for over 40 languages.
- Service & Web Bookmarks - Add custom links to the homepage.
- Docker Integration - Container status and stats. Automatic service discovery via labels.
- Service Integration - Over 100 service integrations, including popular starr and self-hosted apps.
- Information & Utility Widgets - Weather, time, date, search, and more.
- And much more...
Homepage has built-in support for Docker, and can automatically discover and add services to the homepage based on labels. See the Docker page for more information.
Homepage also has support for over 100 3rd party services, including all popular starr 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 page for more information.
Homepage 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 page for more information.
Homepage is highly customizable, with support for custom themes, custom CSS & JS, custom layouts, formatting, localization and more. See the Settings page for more information.
For configuration options, examples and more, please check out the homepage documentation.
Using docker compose:
version: "3.3" services: homepage: image: ghcr.io/gethomepage/homepage:latest container_name: homepage environment: PUID: 1000 -- optional, your user id PGID: 1000 -- optional, your group id ports: - 3000:3000 volumes: - /path/to/config:/app/config # Make sure your local config directory exists - /var/run/docker.sock:/var/run/docker.sock:ro # optional, for docker integrations restart: unless-stopped
or docker run:
docker run --name homepage \ -e PUID=1000 \ -e PGID=1000 \ -p 3000:3000 \ -v /path/to/config:/app/config \ -v /var/run/docker.sock:/var/run/docker.sock:ro \ --restart unless-stopped \ ghcr.io/gethomepage/homepage:latest
First, clone the repository:
git clone https://github.com/gethomepage/homepage.git
Then install dependencies and build the production bundle (I'm using pnpm here, you can use npm or yarn if you like):
pnpm install pnpm build
If this is your first time starting, copy the
src/skeleton directory to
config/ to populate initial example config files.
Finally, run the server in production mode:
or development mode:
Please refer to the homepage documentation website 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.
Install NPM packages, this project uses pnpm (and so should you!):
Start the development server:
Open http://localhost:3000 to start.
This is a Next.js application, see their documentation for more information.
The homepage documentation is available at https://gethomepage.dev/.
Homepage uses Material for MkDocs for documentation. To run the documentation locally, first install the dependencies:
pip install -r requirements.txt
Then run the development server:
mkdocs serve # or build, to build the static site
Support & Suggestions
If you have any questions, suggestions, or general issues, please start a discussion on the Discussions page.
For bug reports, please open an issue on the Issues page.
Contributing & Contributors
Contributions are welcome! Please see the CONTRIBUTING.md file for more information.
Thanks to the over 200 contributors who have helped make this project what it is today!
Especially huge thanks to @shamoon, who has been the backbone of this community from the very start.