A highly customizable homepage (or startpage / application dashboard) with Docker and service API integrations.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Go to file
quietsy c6770d233c
Feature: SWAG dashboard widget (#3523)
2 days ago
.devcontainer Chore: add Python requirements and prettier to devcontaier (#2878) 4 months ago
.github Chore: fix ypos in the PR template (#3209) 2 months ago
.vscode add mkdocs 8 months ago
docs Feature: SWAG dashboard widget (#3523) 2 days ago
images update readme image 9 months ago
k3d Run pre-commit hooks over existing codebase 7 months ago
public Feature: SWAG dashboard widget (#3523) 2 days ago
src Feature: SWAG dashboard widget (#3523) 2 days ago
.all-contributorsrc Update .all-contributorsrc 2 years ago
.babelrc Revert "Chore: enable swc (#2311)" 6 months ago
.dockerignore Update GameDig dependency to `4.1.0` and revert compressjs fix. (#1939) 9 months ago
.editorconfig first public source commit 2 years ago
.eslintrc.json starting of widget refactoring 2 years ago
.gitignore ignore mkdocs cache 8 months ago
.pre-commit-config.yaml Add pre-commit with prettier 7 months ago
.prettierrc Add pre-commit with prettier 7 months ago
CODE_OF_CONDUCT.md Run pre-commit hooks over existing codebase 7 months ago
CONTRIBUTING.md Update contributing / development guidelines 2 months ago
Dockerfile Remove deprecated notification 8 months ago
Dockerfile-tilt added k3d test scripts 1 year ago
LICENSE Initial commit 2 years ago
README.md Documentation: DO Credits (#3505) 1 week ago
crowdin.yml Chore: migrate crowdin to GHA (#2421) 6 months ago
docker-entrypoint.sh Use HOMEPAGE_BUILDTIME to revalidate container restart/recreate 1 year ago
jsconfig.json Run pre-commit hooks over existing codebase 7 months ago
kubernetes.md Run pre-commit hooks over existing codebase 7 months ago
mkdocs.yml Feature: SWAG dashboard widget (#3523) 2 days ago
next-i18next.config.js Enhancement: locale option for date & relativeDate format (#2658) 4 months ago
next.config.js Chore: enable swc, again (#2385) 6 months ago
package-lock.json Chore(deps-dev): Bump eslint-config-next from 12.3.4 to 14.2.3 (#3399) 4 weeks ago
package.json Chore(deps-dev): Bump eslint-config-next from 12.3.4 to 14.2.3 (#3399) 4 weeks ago
pnpm-lock.yaml Chore(deps-dev): Bump eslint-config-next from 12.3.4 to 14.2.3 (#3399) 4 weeks ago
postcss.config.js Run pre-commit hooks over existing codebase 7 months ago
requirements.txt Remove mkdocs-material insiders 4 months ago
tailwind.config.js Feature: iFrame widget (#2261) 7 months ago

README.md

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.

GitHub Workflow Status (with event)     Discord     GitHub Sponsors

DigitalOcean Referral Badge

Homepage builds are kindly powered by DigitalOcean.

Features

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...

Docker Integration

Homepage has built-in support for Docker, and can automatically discover and add services to the homepage based on labels. See the Docker Service Discovery page for more information.

Service Widgets

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.

Information Widgets

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.

Customization

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.

Getting Started

For configuration options, examples and more, please check out the homepage documentation.

With Docker

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

With Node

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:

pnpm start

or development mode:

pnpm dev

Configuration

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.

Development

Install NPM packages, this project uses pnpm (and so should you!):

pnpm install

Start the development server:

pnpm dev

Open http://localhost:3000 to start.

This is a Next.js application, see their documentation for more information.

Documentation

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.

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.