📝 Updates documentation
Thanks to @walkxcode
This commit is contained in:
104
README.md
104
README.md
@@ -1,5 +1,5 @@
|
|||||||
<h3 align="center">Homarr</h3>
|
<h3 align="center">Homarr</h3>
|
||||||
<br/>
|
<br>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://github.com/ajnart/homarr/actions/workflows/docker.yml">
|
<a href="https://github.com/ajnart/homarr/actions/workflows/docker.yml">
|
||||||
<img title="Docker CI Status" src="https://github.com/ajnart/homarr/actions/workflows/docker.yml/badge.svg" alt="CI Status"></a>
|
<img title="Docker CI Status" src="https://github.com/ajnart/homarr/actions/workflows/docker.yml/badge.svg" alt="CI Status"></a>
|
||||||
@@ -30,12 +30,19 @@
|
|||||||
- [📃 Table of Contents](#-table-of-contents)
|
- [📃 Table of Contents](#-table-of-contents)
|
||||||
- [🚀 Getting Started](#-getting-started)
|
- [🚀 Getting Started](#-getting-started)
|
||||||
- [ℹ️ About](#ℹ️-about)
|
- [ℹ️ About](#ℹ️-about)
|
||||||
- [🐛 Known Issues](#-known-issues)
|
- [💥 Known Issues](#-known-issues)
|
||||||
- [⚡ Installation](#-installation)
|
- [⚡ Installation](#-installation)
|
||||||
- [Deploying from Docker Image 🐳](#deploying-from-docker-image-)
|
- [🐳 Deploying from Docker Image](#-deploying-from-docker-image)
|
||||||
- [Building from Source 🛠️](#building-from-source-️)
|
- [🛠️ 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)
|
- [💖 Contributing](#-contributing)
|
||||||
|
|
||||||
|
|
||||||
<!-- Getting Started -->
|
<!-- Getting Started -->
|
||||||
# 🚀 Getting Started
|
# 🚀 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)**
|
**[⤴️ 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
|
## ⚡ Installation
|
||||||
|
|
||||||
### Deploying from Docker Image 🐳
|
### 🐳 Deploying from Docker Image
|
||||||
> Supported architectures: x86-64, ARM, ARM64
|
> Supported architectures: x86-64, ARM, ARM64
|
||||||
|
|
||||||
_Requirements_:
|
_Requirements_:
|
||||||
@@ -78,7 +92,7 @@ services:
|
|||||||
|
|
||||||
***Getting EACCESS errors in the logs? Try running `sudo chmod 775 /directory-you-mounted-to`!***
|
***Getting EACCESS errors in the logs? Try running `sudo chmod 775 /directory-you-mounted-to`!***
|
||||||
|
|
||||||
### Building from Source 🛠️
|
### 🛠️ Building from Source
|
||||||
|
|
||||||
_Requirements_:
|
_Requirements_:
|
||||||
- [Git](https://git-scm.com/downloads)
|
- [Git](https://git-scm.com/downloads)
|
||||||
@@ -93,6 +107,84 @@ _Requirements_:
|
|||||||
- Start the NextJS web server: ``yarn start``
|
- Start the NextJS web server: ``yarn start``
|
||||||
- *Note: If you want to update the code in real time, launch with ``yarn dev``*
|
- *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.*<br>
|
||||||
|
Make a new API key in `Advanced > Security > Create new API key`<br>
|
||||||
|
**Current integration:** Upcoming media is displayed in the **Calendar** module.
|
||||||
|
|
||||||
|
**Plex**
|
||||||
|
*The Plex integration is still in development.*
|
||||||
|
|
||||||
|
**Radarr**
|
||||||
|
*Radarr needs an API key.*<br>
|
||||||
|
Make a new API key in `Advanced > Security > Create new API key`<br>
|
||||||
|
**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: <br>
|
||||||
|
`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
|
# 💖 Contributing
|
||||||
**Please read our [Contribution Guidelines](/CONTRIBUTING.md)**
|
**Please read our [Contribution Guidelines](/CONTRIBUTING.md)**
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user