open-source-mirrors
/
homepage
mirror of https://github.com/benphelps/homepage
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
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.
966 Commits
6 Branches
109 Tags
318 MiB
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '0159be798f'
${ noResults }
Go to file
frozendark_ 0159be798f
Translated using Weblate (Romanian) 		2 years ago
.github Update docker-publish.yml 2 years ago
.vscode Decompose i18n labels for Unifi widget 2 years ago
images new logo and styling tweaks 2 years ago
public Translated using Weblate (Romanian) 2 years ago
src add changelog link to version 2 years ago
.babelrc
…
.dockerignore
…
.editorconfig
…
.eslintrc.json starting of widget refactoring 2 years ago
.gitignore Add Winston for log handling 2 years ago
CODE_OF_CONDUCT.md
…
CONTRIBUTING.md
…
Dockerfile add version information 2 years ago
LICENSE
…
README.md Update README.md 2 years ago
docker-entrypoint.sh experiment with entrypoint for backwards compat 2 years ago
jsconfig.json
…
next-i18next.config.js only render en by default 2 years ago
next.config.js refactor i18n to be server side 2 years ago
package.json Plex service widget without Tautulli 2 years ago
pnpm-lock.yaml Plex service widget without Tautulli 2 years ago
postcss.config.js
…
tailwind.config.js starting of widget refactoring 2 years ago

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), Romainian, 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 Wiki.

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