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.
homepage/README.md

156 lines
6.0 KiB

2 years ago
<p align="center">
2 years ago
<picture>
<source media="(prefers-color-scheme: dark)" srcset="images/banner_light@2x.png">
<img src="images/banner_dark@2x.png" width="65%">
2 years ago
</picture>
2 years ago
</p>
<p align="center">
1 year ago
A modern, <em>fully static, fast</em>, secure <em>fully proxied</em>, highly customizable application dashboard with integrations for over 100 services and translations into multiple languages. Easily configured via YAML files or through docker label discovery.
2 years ago
</p>
<p align="center">
<img src="images/1.png?v=2" />
2 years ago
</p>
<p align="center">
1 year ago
<a href="https://github.com/benphelps/homepage/actions/workflows/docker-publish.yml"><img alt="GitHub Workflow Status (with event)" src="https://img.shields.io/github/actions/workflow/status/benphelps/homepage/docker-publish.yml"></a>
&nbsp;
<a href="https://hosted.weblate.org/engage/homepage/"><img src="https://hosted.weblate.org/widgets/homepage/-/homepage/svg-badge.svg" alt="Weblate"></a>
&nbsp;
<a href="https://discord.gg/k4ruYNrudu"><img alt="Discord" src="https://img.shields.io/discord/1019316731635834932"></a>
&nbsp;
<a href="https://paypal.me/phelpsben" title="Donate"><img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/benphelps"></a>
2 years ago
</p>
1 year ago
# Features
2 years ago
1 year ago
With features like quick search, bookmarks, weather support, a wide range of integrations and widgets, an elegant and modern design, and a focus on performance, Homepage is your ideal start to the day and a handy companion throughout it.
2 years ago
1 year ago
- **Fast** - The site is statically generated at build time for instant load times.
- **Secure** - All API requests to backend services are proxied, keeping your API keys hidden. Constantly reviewed for security by the community.
- **For Everyone** - Images built for AMD64, ARM64, ARMv7, and ARMv6.
- **Full i18n** - Support for over 40 languages.
- **Service & Web Bookmarks** - Add custom links to the homepage.
- **Docker Integration** - Container status and stats. Automatic service discovery via labels.
- **Service Integration** - Over 100 service integrations, including popular starr and self-hosted apps.
- **Information & Utility Widgets** - Weather, time, date, search, and more.
- **And much more...**
2 years ago
1 year ago
## Docker Integration
Homepage has built-in support for Docker, and can automatically discover and add services to the homepage based on labels. See the [Docker](https://gethomepage.dev/en/installation/docker/) page for more information.
## Service Widgets
Homepage also has support for over 100 3rd party services, including all popular starr apps, and most popular self-hosted apps. Some examples include: Radarr, Sonarr, Lidarr, Bazarr, Ombi, Tautulli, Plex, Jellyfin, Emby, Transmission, qBittorrent, Deluge, Jackett, NZBGet, SABnzbd, etc. As well as service integrations, Homepage also has a number of information providers, sourcing information from a variety of external 3rd party APIs. See the [Service](https://gethomepage.dev/en/configs/service-widgets/) page for more information.
2 years ago
1 year ago
## Information Widgets
1 year ago
Homepage has built-in support for a number of information providers, including weather, time, date, search, glances and more. System and status information presented at the top of the page. See the [Information Providers](https://gethomepage.dev/en/configs/widgets/) page for more information.
1 year ago
## Customization
Homepage is highly customizable, with support for custom themes, custom CSS & JS, custom layouts, formatting, localization and more. See the [Settings](https://gethomepage.dev/en/configs/settings/) page for more information.
# Getting Started
For configuration options, examples and more, [please check out the homepage documentation](http://gethomepage.dev).
## With Docker
2 years ago
Using docker compose:
```yaml
2 years ago
version: "3.3"
2 years ago
services:
2 years ago
homepage:
image: ghcr.io/benphelps/homepage:latest
container_name: homepage
1 year ago
environment:
PUID: 1000 -- optional, your user id
PGID: 1000 -- optional, your group id
2 years ago
ports:
- 3000:3000
volumes:
2 years ago
- /path/to/config:/app/config # Make sure your local config directory exists
1 year ago
- /var/run/docker.sock:/var/run/docker.sock:ro # optional, for docker integrations
restart: unless-stopped
2 years ago
```
or docker run:
```bash
1 year ago
docker run --name homepage \
-e PUID=1000 \
-e PGID=1000 \
-p 3000:3000 \
-v /path/to/config:/app/config \
-v /var/run/docker.sock:/var/run/docker.sock:ro \
--restart unless-stopped \
ghcr.io/benphelps/homepage:latest
2 years ago
```
1 year ago
## 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
```
2 years ago
If this is your first time starting, copy the `src/skeleton` directory to `config/` to populate initial example config files.
1 year ago
Finally, run the server in production mode:
```bash
pnpm start
```
1 year ago
or development mode:
2 years ago
1 year ago
```bash
pnpm dev
```
2 years ago
1 year ago
# Configuration
2 years ago
1 year ago
Please refere to the [homepage documentation](https://gethomepage.dev/) website for more information. Everything you need to know about configuring Homepage is there. Please read everything carefully before asking for help, as most questions are answered there or are simple YAML configuration issues.
1 year ago
# Development
2 years ago
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 documentation for more information:
1 year ago
# Support & Suggestions
2 years ago
1 year ago
If you have any questions, suggestions, or general issues, please start a discussion on the [Discussions](https://github.com/benphelps/homepage/discussions) page.
2 years ago
1 year ago
For bug reports, please open an issue on the [Issues](https://github.com/benphelps/homepage/issues) page.
2 years ago
1 year ago
## Contributing & Contributers
2 years ago
1 year ago
Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.
2 years ago
1 year ago
Thanks to the over 200 contributors who have helped make this project what it is today!