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.
112 lines
4.3 KiB
112 lines
4.3 KiB
|
|
|
|
[](https://github.com/benphelps/homepage/actions/workflows/docker-publish.yml)
|
|
[](https://hosted.weblate.org/engage/homepage/)
|
|
|
|
## Features
|
|
|
|
* Fast! The entire site is statically generated at build time, so you can expect instant load times.
|
|
* Images built for AMD64 (x86_64), ARM64, ARMv7 and ARMv6 ([schklom](https://github.com/benphelps/homepage/pull/3) and [modem7](https://github.com/benphelps/homepage/pull/62))
|
|
- Supports all Raspberry Pi's, most SBCs & Apple Silicon
|
|
* Full i18n support with automatic language detection.
|
|
- Human translations for English, Norwegian Bokmål ([comradekingu](https://github.com/benphelps/homepage/commits?author=comradekingu)), Spanish ([AmadeusGraves](https://github.com/benphelps/homepage/commits?author=AmadeusGraves)), French (J. Lavoie), Dutch ([deffcolony](https://github.com/benphelps/homepage/commits?author=deffcolony)), Chinese ([nicedc](https://github.com/nicedc)) and Russian ([desolaris](https://github.com/benphelps/homepage/commits?author=desolaris)).
|
|
- Machine translations for Portuguese and German.
|
|
- Want to help translate? [Join the Weblate project](https://hosted.weblate.org/engage/homepage/).
|
|
* Service & Web Bookmarks
|
|
* Docker Integration
|
|
- Container status (Running / Stopped) & statistics (CPU, Memory, Network)
|
|
- Automatic service discovery (via labels)
|
|
* Service Integration
|
|
- Currently supports Sonarr, Radarr, Ombi, Emby, Jellyfin, Tautulli (Plex), Overseerr, Jellyseerr ([ilusi0n](https://github.com/benphelps/homepage/pull/34)), NZBGet, ruTorrent
|
|
- Portainer, Traefik, Speedtest Tracker, PiHole, Nginx Proxy Manager ([aidenpwnz](https://github.com/benphelps/homepage/pull/45))
|
|
- Readarr, SABnzbd ([JazzFisch]())
|
|
* Information & Utility Widgets
|
|
- System Stats (Disk, CPU, Memory)
|
|
- Weather via WeatherAPI.com or OpenWeatherMap ([AlexFullmoon](https://github.com/benphelps/homepage/pull/25))
|
|
- Automatic location detection (with HTTPS), or manual location selection
|
|
- Search Bar ([aidenpwnz](https://github.com/benphelps/homepage/pull/45))
|
|
* Customizable
|
|
- 21 theme colors with light and dark mode support
|
|
- Background image support
|
|
|
|
## Support & Suggestions
|
|
|
|
If you have any questions, suggestions, or general issues, please start a discussion on the [Discussions](https://github.com/benphelps/homepage/discussions) page.
|
|
|
|
If you have a more specific issue, please open an issue on the [Issues](https://github.com/benphelps/homepage/issues) page.
|
|
|
|
## Getting Started
|
|
|
|
For configuration options, examples and more, [please check out the Wiki](https://github.com/benphelps/homepage/wiki).
|
|
|
|
### With Docker
|
|
|
|
Using docker compose:
|
|
|
|
```yaml
|
|
version: '3.3'
|
|
services:
|
|
homepage:
|
|
image: ghcr.io/benphelps/homepage:latest
|
|
container_name: homepage
|
|
ports:
|
|
- 3000:3000
|
|
volumes:
|
|
- /path/to/config:/app/config
|
|
- /var/run/docker.sock:/var/run/docker.sock # (optional) For docker integrations
|
|
```
|
|
|
|
or docker run:
|
|
|
|
```bash
|
|
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:
|
|
|
|
```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.
|
|
|
|
You may also check [the wiki](https://github.com/benphelps/homepage/wiki) for detailed configuration instructions, examples and more.
|
|
|
|
## 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:
|