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.
89 lines
1.8 KiB
89 lines
1.8 KiB
|
|
|
|
|
|
## Features
|
|
|
|
* Web Bookmarks
|
|
* Service Bookmarks
|
|
- Docker Integration
|
|
- Status light + CPU, Memory & Network Reporting
|
|
- Service Integration
|
|
- Currently supports Sonarr, Radarr, Ombi, Emby, NZBGet, ruTorrent, Portainer & PiHole
|
|
* Homepage Widgets
|
|
- System Stats (Disk, CPU, Memory)
|
|
- Weather (via weatherapi.com)
|
|
* Customizable
|
|
- 21 theme colors with light and dark mode support
|
|
|
|
## Getting Started
|
|
|
|
You can run the homepage from a docker container or locally using node.
|
|
|
|
### With Docker
|
|
|
|
Using docker compose:
|
|
|
|
```yaml
|
|
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:
|
|
|
|
```bash
|
|
docker run -p 3000:3000 -v /path/to/config:/app/config ghcr.io/benphelps/homepage:main
|
|
```
|
|
|
|
### With Node
|
|
|
|
First, clone the repository:
|
|
|
|
```bash
|
|
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):
|
|
|
|
```bash
|
|
pnpm install
|
|
pnpm build
|
|
```
|
|
|
|
Finally, run the server:
|
|
|
|
```bash
|
|
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.
|
|
|
|
## Development
|
|
|
|
Install NPM packages, this project uses [pnpm](https://pnpm.io/) (and so should you!):
|
|
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
Start the development server:
|
|
|
|
```bash
|
|
pnpm dev
|
|
```
|
|
|
|
Open [http://localhost:3000](http://localhost:3000) to start.
|
|
|
|
This is a [Next.js](https://nextjs.org/) application, see their doucmentation for more information:
|