diff --git a/README.md b/README.md index d1a5fc410..5433cbded 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

Homarr

-
+

CI Status @@ -30,12 +30,19 @@ - [๐Ÿ“ƒ Table of Contents](#-table-of-contents) - [๐Ÿš€ Getting Started](#-getting-started) - [โ„น๏ธ About](#โ„น๏ธ-about) - - [๐Ÿ› Known Issues](#-known-issues) + - [๐Ÿ’ฅ Known Issues](#-known-issues) - [โšก Installation](#-installation) - - [Deploying from Docker Image ๐Ÿณ](#deploying-from-docker-image-) - - [Building from Source ๐Ÿ› ๏ธ](#building-from-source-๏ธ) + - [๐Ÿณ Deploying from Docker Image](#-deploying-from-docker-image) + - [๐Ÿ› ๏ธ Building from Source](#%EF%B8%8F-building-from-source) + - [๐Ÿ”ง Configuration](#-configuration) + - [๐Ÿงฉ Integrations](#--integrations) + - [๐Ÿง‘โ€๐Ÿคโ€๐Ÿง‘ Multiple Configs](#-multiple-configs) + - [๐Ÿป Icons](#-icons) + - [๐Ÿ“Š Modules](#-modules) + - [๐Ÿ” Search Bar](#-search-bar) - [๐Ÿ’– Contributing](#-contributing) + # ๐Ÿš€ Getting Started @@ -45,9 +52,16 @@ Homarr is a simple and lightweight homepage for your server, that helps you easi **[โคด๏ธ Back to Top](#-table-of-contents)** +## ๐Ÿ’ฅ Known Issues +- Posters on the Calendar get blocked by adblockers. (IMDb posters) +- Editing a service creates a duplicate (#97) +- Used search engine not properly selected (#35) + +**[โคด๏ธ Back to Top](#-table-of-contents)** + ## โšก Installation -### Deploying from Docker Image ๐Ÿณ +### ๐Ÿณ Deploying from Docker Image > Supported architectures: x86-64, ARM, ARM64 _Requirements_: @@ -78,7 +92,7 @@ services: ***Getting EACCESS errors in the logs? Try running `sudo chmod 775 /directory-you-mounted-to`!*** -### Building from Source ๐Ÿ› ๏ธ +### ๐Ÿ› ๏ธ Building from Source _Requirements_: - [Git](https://git-scm.com/downloads) @@ -93,6 +107,84 @@ _Requirements_: - Start the NextJS web server: ``yarn start`` - *Note: If you want to update the code in real time, launch with ``yarn dev``* +## ๐Ÿ”ง Configuration + +### ๐Ÿงฉ Integrations + +Homarr natively integrates with your services. Here is a list of all supported services. + +**Emby** +*The Emby integration is still in development.* + +**Lidarr** +*The Lidarr integration is still in development.* + +**Sonarr** +*Sonarr needs an API key.*
+Make a new API key in `Advanced > Security > Create new API key`
+**Current integration:** Upcoming media is displayed in the **Calendar** module. + +**Plex** +*The Plex integration is still in development.* + +**Radarr** +*Radarr needs an API key.*
+Make a new API key in `Advanced > Security > Create new API key`
+**Current integration:** Upcoming media is displayed in the **Calendar** module. + +**qBittorent** +*The qBittorent integration is still in development.* + +**[โคด๏ธ Back to Top](#-table-of-contents)** + +### ๐Ÿง‘โ€๐Ÿคโ€๐Ÿง‘ Multiple Configs + +Homarr allows the usage of multiple configs. You can add a new config in two ways. + +**Drag-and-Drop** +1. Download your config from the Homarr settings. +2. Change the name of the `.json` file and the name in the `.json` file to any name you want *(just make sure it's different)*. +3. Drag-and-Drop the file into the Homarr tab in your browser. +4. Change the config in settings. + +**Using a filebrowser** +1. Locate your mounted `default.json` file. +2. Duplicate your `default.json` file. +3. Change the name of the `.json` file and the name in the `.json` file to any name you want *(just make sure it's different)*. +4. Refresh the Homarr tab in your browser. +5. Change the config in settings. + +**[โคด๏ธ Back to Top](#-table-of-contents)** + +### ๐Ÿป Icons + +The icons used in Homarr are automatically requested from the [dashboard-icons](https://github.com/walkxhub/dashboard-icons) repo. + +Icons are requested in the following way:
+`Grab name > Replace ' ' with '-' > .toLower() > https://cdn.jsdelivr.net/gh/walkxhub/dashboard-icons/png/{name}.png` + +**[โคด๏ธ Back to Top](#-table-of-contents)** + +### ๐Ÿ“Š Modules + +Modules are blocks shown on the sides of the Homarr dashboard that display information. They can be enabled in settings. + +**Clock Module** +The clock module will display your current time and date. + +**Calendar Module** +The Calendar module uses [integrations](#--integrations-1) to display new content. + +**[โคด๏ธ Back to Top](#-table-of-contents)** + +### ๐Ÿ” Search Bar + +The Search Bar will open any Search Query after the Query URL you've specified in settings. + +*(Eg. `https://www.google.com/search?q=*Your Query will be inserted here*`)* + +**[โคด๏ธ Back to Top](#-table-of-contents)** + # ๐Ÿ’– Contributing **Please read our [Contribution Guidelines](/CONTRIBUTING.md)**