Portainer Templates logo

Portainer Templates

Homepage (container) Homepage (container)

ToolsNetwork WebNetwork OtherStatus Stable

A modern (fully static, fast), secure (fully proxied), highly customizable application dashboard with integrations for more than 25 services and translations for over 15 languages. Easily configured via YAML files (or discovery via docker labels).

Image details

Architecture: amd64, arm64, arm/v7, arm/v6
Image size: 60 MB
User: benphelps

Source details

Repo: benphelps/homepage
Stars: 198
Forks: 11
Language: JavaScript
License: GPL-3.0
Updated: 9 months ago
Website: gethomepage.dev/

Configuration

Type
Container
Image
ghcr.io/benphelps/homepage:latest
Ports
3000/tcp
Volumes
/app/config : /opt/mediadepot/apps/homepage/etc/localtime : /etc/localtime
Env vars
PGID=15000PUID=15000TZ=America/Los_Angeles
Labels
traefik.enable=truetraefik.http.services.homepage.loadbalancer.server.port=3000traefik.http.routers.homepage.entrypoints=websecuretraefik.http.routers.homepage.tls.certresolver=mydnschallenge

Template by mediadepot

Standalone Install

Select an install method, to see config/commands for deploying Homepage (container)

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Homepage (container), fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation, or see benphelps/homepage for app-specific guidance.

<source media="(prefers-color-scheme: dark)" srcset="images/banner_light@2x.png">
<img src="https://raw.githubusercontent.com/benphelps/homepage/HEAD/images/banner_dark@2x.png" width="65%">


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

Security Notice 🔒

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

With Docker

Using docker compose:
services:
  homepage:
    image: ghcr.io/gethomepage/homepage:latest
    container_name: homepage
    environment:
      HOMEPAGE_ALLOWED_HOSTS: gethomepage.dev # required, may need port. See gethomepage.dev/installation/#homepage_allowed_hosts
      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 HOMEPAGE_ALLOWED_HOSTS=gethomepage.dev \
  -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

From Source

First, clone the repository:
git clone https://github.com/gethomepage/homepage.git

Then install dependencies and build the production bundle:
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

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.

Troubleshooting

In addition to the docs, the troubleshooting guide can help reveal many basic config or network issues. If you're having a problem, it's a good place to start.

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.

Serve Homepage (container) on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying homepage-container.example.com to http://homepage:3000

Add this to your Caddyfile

homepage-container.example.com {
	reverse_proxy http://homepage:3000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs homepage
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Published on a random port

This template exposes 3000/tcp without setting a host port, so Docker picks a random free one on every deploy.

  • Find it in the Ports column of Portainer's container list, or with docker port homepage

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 15000:15000 /opt/mediadepot/apps/homepage
  • Or set the PUID and PGID variables (defaults 15000:15000) to match your own user, found with id $USER
  • Seeing "read-only file system"? /etc/localtime is mounted read-only on purpose, the app isn't meant to write there.

Image won't pull

Test the pull directly on the host: docker pull ghcr.io/benphelps/homepage:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm/v7, arm/v6
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Homepage (container) runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Homepage (container) needs bundled into one download. This template pulls ghcr.io/benphelps/homepage:latest, which Docker fetches once (about 60 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Homepage (container)'s comes from the GitHub Container Registry, published by benphelps.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, arm/v6, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. Here the app exposes a port but leaves the host side blank, so Docker picks a free one for you. It opens:

  • 3000, published on a random host port

Volumes

A volume is where Homepage (container) keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /app/config from /opt/mediadepot/apps/homepage on the host
  • /etc/localtime from /etc/localtime on the host, read-only

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Homepage (container) takes 3 of them, all with defaults you can leave alone or tweak:

  • PGID, defaults to 15000
  • PUID, defaults to 15000
  • TZ, defaults to America/Los_Angeles

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Homepage (container) sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container homepage. That's what you'll spot in the containers list and use in commands like docker logs homepage.

Labels

Labels are small notes pinned to the container. They don't change how Homepage (container) behaves, but other tools read them, most often a reverse proxy like Traefik working out which apps to route where. This template sets:

  • traefik.enable=true
  • traefik.http.services.homepage.loadbalancer.server.port=3000
  • traefik.http.routers.homepage.entrypoints=websecure
  • traefik.http.routers.homepage.tls.certresolver=mydnschallenge

Open source license

Homepage (container) is open source, released under the GPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Homepage (container) up. Add the template list to Portainer once, then deploying Homepage (container) is a click rather than a wall of config.