From adeffbcf712ddd801e603a8076d1909af8b81131 Mon Sep 17 00:00:00 2001 From: Ben Phelps Date: Thu, 15 Sep 2022 08:44:52 +0300 Subject: [PATCH] update readme --- README.md | 107 +++++++++++++++++++++++++++--------------------------- 1 file changed, 54 insertions(+), 53 deletions(-) diff --git a/README.md b/README.md index fd45423c8..ef5d2ddf3 100644 --- a/README.md +++ b/README.md @@ -5,30 +5,30 @@ ## 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 - - Supports all Raspberry Pi's, most SBCs & Apple Silicon - * Full i18n support with automatic language detection - - Translations for Chinese, Dutch, French, German, Norwegian Bokmål, Portuguese, Russian and Spanish - - 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 - - Sonarr, Radarr, Readarr, Prowlarr, Emby, Jellyfin, Tautulli (Plex) - - Ombi, Overseerr, Jellyseerr, NZBGet, SABnzbd, ruTorrent, Transmission - - Portainer, Traefik, Speedtest Tracker, PiHole, Nginx Proxy Manager, Gotify - * Information Providers - - Coin Market Cap - * Information & Utility Widgets - - System Stats (Disk, CPU, Memory) - - Weather via WeatherAPI.com or OpenWeatherMap - - Automatic location detection (with HTTPS), or manual location selection - - Search Bar - * Customizable - - 21 theme colors with light and dark mode support - - Background image support +- 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 + - Supports all Raspberry Pi's, most SBCs & Apple Silicon +- Full i18n support with automatic language detection + - Translations for Chinese, Dutch, French, German, Norwegian Bokmål, Portuguese, Russian and Spanish + - 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 + - Sonarr, Radarr, Readarr, Prowlarr, Emby, Jellyfin, Tautulli (Plex) + - Ombi, Overseerr, Jellyseerr, NZBGet, SABnzbd, ruTorrent, Transmission + - Portainer, Traefik, Speedtest Tracker, PiHole, Nginx Proxy Manager, Gotify +- Information Providers + - Coin Market Cap +- Information & Utility Widgets + - System Stats (Disk, CPU, Memory) + - Weather via WeatherAPI.com or OpenWeatherMap + - Automatic location detection (with HTTPS), or manual location selection + - Search Bar +- Customizable + - 21 theme colors with light and dark mode support + - Background image support ## Support & Suggestions @@ -45,16 +45,17 @@ For configuration options, examples and more, [please check out the Wiki](https: Using docker compose: ```yaml -version: '3.3' +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 + homepage: + image: ghcr.io/benphelps/homepage:latest + container_name: homepage + user: 1000:1000 # Optional, change to your user and group IDs for permissions + ports: + - 3000:3000 + volumes: + - /path/to/config:/app/config # Make sure your local config directory is exists + - /var/run/docker.sock:/var/run/docker.sock # (optional) For docker integrations ``` or docker run: @@ -90,7 +91,7 @@ pnpm start 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 +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. @@ -115,22 +116,22 @@ This is a [Next.js](https://nextjs.org/) application, see their doucmentation fo ## Contributors -Huge thanks to the all the contributors who have helped make this project what it is today! In alphabetical order: - - * [aidenpwnz](https://github.com/benphelps/homepage/commits?author=aidenpwnz) - Nginx Proxy Manager, Search Bar Widget - * [AlexFullmoon](https://github.com/benphelps/homepage/commits?author=AlexFullmoon) - OpenWeatherMap Widget - * [AmadeusGraves](https://github.com/benphelps/homepage/commits?author=AmadeusGraves) - Spanish Translation - * [boerniee](https://github.com/benphelps/homepage/commits?author=boerniee) - German Translation - * [comradekingu](https://github.com/benphelps/homepage/commits?author=comradekingu) - Norwegian Bokmål Translation - * [deffcolony](https://github.com/benphelps/homepage/commits?author=deffcolony) - Dutch Translation - * [desolaris](https://github.com/benphelps/homepage/commits?author=desolaris) - Russian Translation - * [ilusi0n](https://github.com/benphelps/homepage/commits?author=ilusi0n) - Jellyseerr Integration - * [ItsJustMeChris](https://github.com/benphelps/homepage/commits?author=ItsJustMeChris) - Coin Market Cap Widget - * [jackblk](https://github.com/benphelps/homepage/commits?author=jackblk) - Vietnamese Translation - * [JazzFisch](https://github.com/benphelps/homepage/commits?author=JazzFisch) - Readarr, SABnzbd & Transmission Integrations - * [modem7](https://github.com/benphelps/homepage/commits?author=modem7) - Impvoed Docker Image - * [nicedc](https://github.com/benphelps/homepage/commits?author=nicedc) - Chinese Translation - * [Nonoss117](https://github.com/benphelps/homepage/commits?author=Nonoss117) - French Translation - * [quod](https://github.com/benphelps/homepage/commits?author=quod) - Fixed Typos - * [schklom](https://github.com/benphelps/homepage/commits?author=schklom) - ARM64, ARMv7 and ARMv6 - * [xicopitz](https://github.com/benphelps/homepage/commits?author=xicopitz) - Gotify & Prowlarr Integration +Huge thanks to the all the contributors who have helped make this project what it is today! In alphabetical order: + +- [aidenpwnz](https://github.com/benphelps/homepage/commits?author=aidenpwnz) - Nginx Proxy Manager, Search Bar Widget +- [AlexFullmoon](https://github.com/benphelps/homepage/commits?author=AlexFullmoon) - OpenWeatherMap Widget +- [AmadeusGraves](https://github.com/benphelps/homepage/commits?author=AmadeusGraves) - Spanish Translation +- [boerniee](https://github.com/benphelps/homepage/commits?author=boerniee) - German Translation +- [comradekingu](https://github.com/benphelps/homepage/commits?author=comradekingu) - Norwegian Bokmål Translation +- [deffcolony](https://github.com/benphelps/homepage/commits?author=deffcolony) - Dutch Translation +- [desolaris](https://github.com/benphelps/homepage/commits?author=desolaris) - Russian Translation +- [ilusi0n](https://github.com/benphelps/homepage/commits?author=ilusi0n) - Jellyseerr Integration +- [ItsJustMeChris](https://github.com/benphelps/homepage/commits?author=ItsJustMeChris) - Coin Market Cap Widget +- [jackblk](https://github.com/benphelps/homepage/commits?author=jackblk) - Vietnamese Translation +- [JazzFisch](https://github.com/benphelps/homepage/commits?author=JazzFisch) - Readarr, Bazarr, Lidarr, SABnzbd & Transmission Integrations +- [modem7](https://github.com/benphelps/homepage/commits?author=modem7) - Impvoed Docker Image +- [nicedc](https://github.com/benphelps/homepage/commits?author=nicedc) - Chinese Translation +- [Nonoss117](https://github.com/benphelps/homepage/commits?author=Nonoss117) - French Translation +- [quod](https://github.com/benphelps/homepage/commits?author=quod) - Fixed Typos +- [schklom](https://github.com/benphelps/homepage/commits?author=schklom) - ARM64, ARMv7 and ARMv6 +- [xicopitz](https://github.com/benphelps/homepage/commits?author=xicopitz) - Gotify & Prowlarr Integration