beenull/homepage
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
A highly customizable homepage (or startpage / application dashboard) with Docker and service API integrations.
1315 commits 6 branches 86 tags 25 MiB
JavaScript 97.6%
CSS 1.6%
Dockerfile 0.4%
Shell 0.3%
Starlark 0.1%
Find a file
Michael Shamoon ce7b532c7f Use node v18 
See https://github.com/nodejs/docker-node/issues/1798
2022-11-03 11:37:54 -07:00
.github Use node v18 2022-11-03 11:37:54 -07:00
.vscode Decompose i18n labels for Unifi widget 2022-10-09 20:05:28 -07:00
images new logo and styling tweaks 2022-10-08 16:04:24 +03:00
public Translated using Weblate (Arabic) 2022-11-03 06:01:55 +01:00
src feat: add tubearchivist widget 2022-10-31 15:23:34 +02:00
.babelrc forcefully disable next-swc 2022-09-07 12:14:06 +03:00
.dockerignore first public source commit 2022-08-24 10:44:35 +03:00
.editorconfig first public source commit 2022-08-24 10:44:35 +03:00
.eslintrc.json starting of widget refactoring 2022-09-25 19:43:47 +03:00
.gitignore Add Winston for log handling 2022-09-20 20:16:04 -07:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2022-09-13 20:56:08 +03:00
CONTRIBUTING.md Create CONTRIBUTING.md 2022-09-13 21:15:55 +03:00
docker-entrypoint.sh experiment with entrypoint for backwards compat 2022-09-14 19:04:19 +03:00
Dockerfile Use node v18 2022-11-03 11:37:54 -07:00
jsconfig.json first public source commit 2022-08-24 10:44:35 +03:00
LICENSE Initial commit 2022-08-24 10:29:42 +03:00
next-i18next.config.js only render en by default 2022-09-26 14:43:03 +03:00
next.config.js refactor i18n to be server side 2022-09-25 19:43:00 +03:00
package.json Plex service widget without Tautulli 2022-10-10 00:31:50 -07:00
pnpm-lock.yaml Plex service widget without Tautulli 2022-10-10 00:31:50 -07:00
postcss.config.js first public source commit 2022-08-24 10:44:35 +03:00
README.md Change wiki links to gethomepage.dev 2022-10-24 10:10:28 -07:00
tailwind.config.js starting of widget refactoring 2022-09-25 19:43:47 +03:00

README.md

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

Linkedin - phelpsben

Docker Weblate

Features

  • Fast! The entire site is statically generated at build time, so you can expect instant load times
  • Secure! Every API request to backend services goes through a proxy server, so your API keys are never exposed to the frontend client.
  • Images built for AMD64 (x86_64), ARM64, ARMv7 and ARMv6
    • Supports all Raspberry Pi's, most SBCs & Apple Silicon
  • Full i18n support with automatic language detection
    • Translations for Catalan, Chinese, Dutch, Finnish, French, German, Hebrew, Hungarian, Norwegian Bokmål, Polish, Portuguese, Portuguese (Brazil), Romanian, Russian, Spanish, Swedish and Yue
    • Want to help translate? Join the Weblate project
  • Service & Web Bookmarks
  • Docker Integration
    • Container status (Running / Stopped) & statistics (CPU, Memory, Network)
    • Automatic service discovery (via labels)
  • Service Integration
    • Sonarr, Radarr, Readarr, Prowlarr, Bazarr, Lidarr, Emby, Jellyfin, Tautulli (Plex)
    • Ombi, Overseerr, Jellyseerr, Jackett, NZBGet, SABnzbd, ruTorrent, Transmission, qBittorrent
    • Portainer, Traefik, Speedtest Tracker, PiHole, AdGuard Home, Nginx Proxy Manager, Gotify, Syncthing Relay Server, Authentic, Proxmox
  • Information Providers
    • Coin Market Cap, Mastodon
  • Information & Utility Widgets
    • System Stats (Disk, CPU, Memory)
    • Weather via WeatherAPI.com or OpenWeatherMap
    • Search Bar
  • Customizable
    • 21 theme colors with light and dark mode support
    • Background image support
    • Column and Row layout options

Support & Suggestions

If you have any questions, suggestions, or general issues, please start a discussion on the Discussions page.

If you have a more specific issue, please open an issue on the Issues page.

Getting Started

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

With Docker

Using docker compose:

version: "3.3"
services:
  homepage:
    image: ghcr.io/benphelps/homepage:latest
    container_name: homepage
    ports:
      - 3000:3000
    volumes:
      - /path/to/config:/app/config # Make sure your local config directory exists
      - /var/run/docker.sock:/var/run/docker.sock # (optional) For docker integrations

or docker run:

docker run -p 3000:3000 -v /path/to/config:/app/config -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/benphelps/homepage:latest

With Node

First, clone the repository:

git clone https://github.com/benphelps/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:

pnpm start

Configuration

Configuration files will be genereted and placed on the first request.

Configuration is done in the /config directory using .yaml files. Refer to each config for the specific configuration options.

You may also check the homepage site for detailed configuration instructions, examples and more.

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 doucmentation for more information:

Contributors

Huge thanks to the all the contributors who have helped make this project what it is today! In alphabetical order:

Translators