From 7ed75e1f5ddb275e2a868763e94cfca7a8084e2b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fernando=20Fern=C3=A1ndez?= Date: Tue, 10 Sep 2024 23:21:22 +0200 Subject: [PATCH] docs(readme): update according to the new deployment documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The new deployment documentation has been pushed to the main Jellyfin documentation: https://github.com/jellyfin/jellyfin.org/pull/1110 The wiki has also been updated to reflect those changes: https://github.com/jellyfin/jellyfin-vue/wiki/Deployment/81af939a4773c985cf5b64a33436200bee0f12f1 The last required piece was the repository's README Signed-off-by: Fernando Fernández --- README.md | 17 +++++------------ 1 file changed, 5 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a00f1695b78..253fe1157d7 100644 --- a/README.md +++ b/README.md @@ -85,25 +85,18 @@ There are no stable releases yet.* ## [Hosted instance 🌍](https://jf-vue.pages.dev/) -Hosted by Cloudflare Pages. +Built from the latest commit in the default branch. Just input your server address when prompted. -⚠️ **This only works for Jellyfin servers that [are behind a reverse proxy and have HTTPS set up correctly](https://jellyfin.org/docs/general/networking/#running-jellyfin-behind-a-reverse-proxy)**. If your server runs over HTTP, you must use another deployment type. +⚠️ **This only works for Jellyfin servers that [are behind a reverse proxy and have HTTPS set up correctly](https://jellyfin.org/docs/general/networking/#running-jellyfin-behind-a-reverse-proxy)**. If your server runs over HTTP, you must host it yourself. -## Docker Container 📦 +Hosted by Cloudflare Pages. -You can run the Docker container with the following command, replacing 8080 with the port of your choice: +## Host it yourself 💽 -```bash -docker run -d -p 8080:80 ghcr.io/jellyfin/jellyfin-vue:unstable -``` +Check [our wiki page](https://github.com/jellyfin/jellyfin-vue/wiki/Deployment) for the most up to date information. You can check [GitHub Packages (GHCR)](https://github.com/jellyfin/jellyfin-vue/pkgs/container/jellyfin-vue) (recommended) or [DockerHub](https://hub.docker.com/r/jellyfin/jellyfin-vue) for all the tagged images. -## Other means 💽 - -There are more ways to host Jellyfin Vue yourself. -Check [our wiki page](https://github.com/jellyfin/jellyfin-vue/wiki/Deployment-methods) for the most up to date information. - ## Privacy disclaimer 🕵🏻 Jellyfin Vue is just a GUI *(Graphical User Interface)* for a Jellyfin server. It only establishes connection to the Jellyfin server that you point it to, **nothing else**.