From 47c636e810e10ed7f10dea0361a48844239cb95c Mon Sep 17 00:00:00 2001 From: Walkx Date: Mon, 16 May 2022 01:30:35 +0200 Subject: [PATCH 1/6] =?UTF-8?q?=F0=9F=93=9D=20Updates=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 90 +++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 84 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d1a5fc410..a5cdbd533 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

Homarr

-
+

CI Status @@ -30,12 +30,18 @@ - [๐Ÿ“ƒ Table of Contents](#-table-of-contents) - [๐Ÿš€ Getting Started](#-getting-started) - [โ„น๏ธ About](#โ„น๏ธ-about) - - [๐Ÿ› 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 @@ -47,7 +53,7 @@ Homarr is a simple and lightweight homepage for your server, that helps you easi ## โšก Installation -### Deploying from Docker Image ๐Ÿณ +### ๐Ÿณ Deploying from Docker Image > Supported architectures: x86-64, ARM, ARM64 _Requirements_: @@ -78,7 +84,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 +99,78 @@ _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** +*Emby does not need an API key.* + +**Lidarr** +*Emby does not need an API key.* + +**Plex** +*Emby does not need an API key.* + +**Radarr** +*Radarr needs an API key.*%3Cbr%3E +Make a new API key in `Advanced > Security > Create new API key` + +**qBittorent** +*Radarr needs an API key.* + +**[โคด๏ธ 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)** From c4df55060b0057407bfd3d7ee999f420c73e0bbd Mon Sep 17 00:00:00 2001 From: Walkx Date: Mon, 16 May 2022 15:43:58 +0200 Subject: [PATCH 2/6] =?UTF-8?q?=F0=9F=93=9D=20Update=20Docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a5cdbd533..dcaa92520 100644 --- a/README.md +++ b/README.md @@ -106,20 +106,23 @@ _Requirements_: Homarr natively integrates with your services. Here is a list of all supported services. **Emby** -*Emby does not need an API key.* +*The Emby integration is still in development.* **Lidarr** -*Emby does not need an API key.* +*The Lidarr integration is still in development.* + +**Sonarr** +*The Sonarr integration is still in development.* **Plex** -*Emby does not need an API key.* +*The Plex integration is still in development.* **Radarr** *Radarr needs an API key.*%3Cbr%3E Make a new API key in `Advanced > Security > Create new API key` **qBittorent** -*Radarr needs an API key.* +*The qBittorent integration is still in development.* **[โคด๏ธ Back to Top](#-table-of-contents)** From 8e03719a51c22ceab68e08bc1762d9099e77298a Mon Sep 17 00:00:00 2001 From: Walkx Date: Mon, 16 May 2022 16:15:04 +0200 Subject: [PATCH 3/6] =?UTF-8?q?=F0=9F=93=9D=20Update=20README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Thomas Camlong <49837342+ajnart@users.noreply.github.com> --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dcaa92520..0847fd3d8 100644 --- a/README.md +++ b/README.md @@ -112,7 +112,9 @@ Homarr natively integrates with your services. Here is a list of all supported s *The Lidarr integration is still in development.* **Sonarr** -*The Sonarr integration is still in development.* +*Sonarr needs an API key.*%3Cbr%3E +Make a new API key in `Advanced > Security > Create new API key` +**Current integration:** Upcomming medias are displayed in the **Calendar** module **Plex** *The Plex integration is still in development.* @@ -120,6 +122,7 @@ Homarr natively integrates with your services. Here is a list of all supported s **Radarr** *Radarr needs an API key.*%3Cbr%3E Make a new API key in `Advanced > Security > Create new API key` +**Current integration:** Upcomming medias are displayed in the **Calendar** module **qBittorent** *The qBittorent integration is still in development.* From c9e58e17da396627b735a07f646d79692d7a293b Mon Sep 17 00:00:00 2001 From: Walkx Date: Mon, 16 May 2022 16:17:41 +0200 Subject: [PATCH 4/6] =?UTF-8?q?=F0=9F=93=9D=20Update=20Docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0847fd3d8..c1c4db123 100644 --- a/README.md +++ b/README.md @@ -112,17 +112,17 @@ Homarr natively integrates with your services. Here is a list of all supported s *The Lidarr integration is still in development.* **Sonarr** -*Sonarr needs an API key.*%3Cbr%3E -Make a new API key in `Advanced > Security > Create new API key` -**Current integration:** Upcomming medias are displayed in the **Calendar** module +*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.*%3Cbr%3E -Make a new API key in `Advanced > Security > Create new API key` -**Current integration:** Upcomming medias are displayed in the **Calendar** module +*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.* From 2fad4d06bd658843a6b8dedf9244aee63891c146 Mon Sep 17 00:00:00 2001 From: Walkx Date: Mon, 16 May 2022 16:58:20 +0200 Subject: [PATCH 5/6] =?UTF-8?q?=F0=9F=93=9D=20Adds=20Known=20Issues?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index c1c4db123..f9dc730b5 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,11 @@ 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) + ## โšก Installation ### ๐Ÿณ Deploying from Docker Image From 62ba99f6cd485bfb9f3ea115f78bd9a24fa041a3 Mon Sep 17 00:00:00 2001 From: Walkx Date: Mon, 16 May 2022 16:59:08 +0200 Subject: [PATCH 6/6] =?UTF-8?q?=F0=9F=93=9D=20Updates=20ToC=20and=20adds?= =?UTF-8?q?=20Back=20to=20Top=20link?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index f9dc730b5..5433cbded 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,7 @@ - [๐Ÿ“ƒ Table of Contents](#-table-of-contents) - [๐Ÿš€ Getting Started](#-getting-started) - [โ„น๏ธ About](#โ„น๏ธ-about) + - [๐Ÿ’ฅ Known Issues](#-known-issues) - [โšก Installation](#-installation) - [๐Ÿณ Deploying from Docker Image](#-deploying-from-docker-image) - [๐Ÿ› ๏ธ Building from Source](#%EF%B8%8F-building-from-source) @@ -56,6 +57,8 @@ Homarr is a simple and lightweight homepage for your server, that helps you easi - 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