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.
20 Commits
6 Branches
113 Tags
308 MiB
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '2fa014445f'
${ noResults }
Go to file
Ben Phelps 2fa014445f
add features to readme 		2 years ago
.github/workflows Create docker-publish.yml 2 years ago
images add preview image 2 years ago
public update favicon 2 years ago
src add theme switcher 2 years ago
.dockerignore first public source commit 2 years ago
.editorconfig first public source commit 2 years ago
.eslintrc.json Initial commit from Create Next App 2 years ago
.gitignore first public source commit 2 years ago
Dockerfile use a custom https agent for self-signed bypass 2 years ago
LICENSE Initial commit 2 years ago
README.md add features to readme 2 years ago
jsconfig.json first public source commit 2 years ago
next.config.js first public source commit 2 years ago
package.json add nzbget service widget 2 years ago
pnpm-lock.yaml add nzbget service widget 2 years ago
postcss.config.js first public source commit 2 years ago
tailwind.config.js add theme switcher 2 years ago

README.md

Homepage Preview

Features

  • Web Bookmarks
  • Service Bookmarks
    • Docker Integration
      • Status light + CPU, Memory & Network Reporting
    • Service Integration
      • Currently supports Sonarr, Radarr, Ombi, Emby, NZBGet & Portainer
  • Homepage Widgets
    • System Stats (Disk, CPU, Memory)
    • Weather (via weatherapi.com)
  • Customizable
    • 21 theme colors with light and dark mode support

Getting Started

Using docker compose:

version: '3.3'
services:
    homepage:
        image: ghcr.io/benphelps/homepage:main
        container_name: homepage
        ports:
            - 3000:3000
        volumes:
            - /path/to/config:/app/config

or docker run:

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

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.

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.