From 8a92f394dc341d79e26d7eff6e90db62ba5f3778 Mon Sep 17 00:00:00 2001 From: Bjorn Lammers Date: Sun, 8 Jan 2023 06:36:24 -0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Link=20to=20the=20docs=20instead?= =?UTF-8?q?=20of=20showing=20outdated/duplicate=20info?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 69 ++++++------------------------------------------------- 1 file changed, 7 insertions(+), 62 deletions(-) diff --git a/README.md b/README.md index 3331187db..14fca34f2 100644 --- a/README.md +++ b/README.md @@ -23,8 +23,9 @@

Join the discord! — Don't forget to star the repo if you are enjoying the project!

+

Read the Docs

- Demo ↗️ • Install ➡️ • Read the Docs 📄 + Demo ↗️ • Install ➡️

--- @@ -36,16 +37,14 @@ Homarr is a simple and lightweight homepage for your server, that helps you easi It integrates with the services you use to display information on the homepage (E.g. Show upcoming Sonarr/Radarr releases). -For a full list of integrations, [head over to our documentation](https://homarr.vercel.app/docs/advanced-configuration/integrations). +For a full list of integrations, [head over to our documentation](https://homarr.dev/docs/advanced-configuration/integrations). If you have any questions about Homarr or want to share information with us, please go to one of the following places: - [Github Discussions](https://github.com/ajnart/homarr/discussions) - [Discord Server](https://discord.gg/aCsmEV5RgA) -*Before you file an [issue](https://github.com/ajnart/homarr/issues/new/choose), make sure you have read the [known issues](#-known-issues) section.* - -**For more information, [read the documentation!](https://homarr.vercel.app/docs/about)** +**For more information, [read the documentation!](https://homarr.dev/docs/about)**
Table of Contents @@ -53,10 +52,7 @@ If you have any questions about Homarr or want to share information with us, ple - [✨ Features](#-features) - [👀 Preview](#-preview) -- [💥 Known Issues](#-known-issues) -- [🚀 Installation](#-installation) - - [🐳 Deploying from Docker Image](#-deploying-from-docker-image) - - [🛠️ Building from Source](#️-building-from-source) +- [🛠️ Running a dev environment](#️-running-a-dev-environment) - [💖 Contributing](#-contributing) - [📜 License](#-license) @@ -87,58 +83,7 @@ If you have any questions about Homarr or want to share information with us, ple --- -## 💥 Known Issues -- Posters on the Calendar get blocked by adblockers. (IMDb posters) - -**[⤴️ Back to Top](#homarr)** - ---- - -## 🚀 Installation -### 🐳 Deploying from Docker Image -> Supported architectures: x86-64, ARM, ARM64 - -_Requirements_: -- [Docker](https://docs.docker.com/get-docker/) - -**Standard Docker Install** -```bash -docker run \ - --name homarr \ - --restart unless-stopped \ - -p 7575:7575 \ - -v ./homarr/configs:/app/data/configs \ - -v ./homarr/icons:/app/public/icons \ - -d ghcr.io/ajnart/homarr:latest -``` - -**Docker Compose** -```yml -version: '3' -#---------------------------------------------------------------------# -# Homarr - A homepage for your server. # -#---------------------------------------------------------------------# -services: - homarr: - container_name: homarr - image: ghcr.io/ajnart/homarr:latest - restart: unless-stopped - volumes: - - ./homarr/configs:/app/data/configs - - ./homarr/icons:/app/public/icons - ports: - - '7575:7575' -``` - -```sh -docker compose up -d -``` - -*Getting EACCESS errors in the logs? Try running `sudo chmod 777 /directory-you-mounted-to`!* - -**[⤴️ Back to Top](#homarr)** - -### 🛠️ Building from Source +### 🛠️ Running a dev environment _Requirements_: - [Git](https://git-scm.com/downloads) @@ -197,7 +142,7 @@ SOFTWARE. ---

- Thank you for visiting! For more information read the documentation! + Thank you for visiting! For more information read the documentation!