mirror of https://github.com/jellyfin/jellyfin-vue.git synced 2024-12-11 15:55:58 +00:00

A modern web client for Jellyfin based on Vue

Go to file

Fernando Fernández 60160e2b66 refactor(JSafeHtml): use createVNode This allows us to directly insert the HTML without adding any extra DOM element Sources: * https://discord.com/channels/325477692906536972/568037134968160256/1254047268441690182 * https://discord.com/channels/325477692906536972/568037134968160256/1254210953415753738 createVnode is internally used by createStaticVNode: `edf263847e/packages/runtime-core/src/vnode.ts (L742)` However, it requires a 2nd parameter, which is the number of nodes we want to insert, which is unknown/not trivial to calculate at runtime. According to the comment in the function, that's only needed for hydration (SSR), so it should be safe for us as we're SPA only. Here's a playground: https://play.vuejs.org/#__PROD__eNp9UsFu2zAM/RVBGFAH9Zxs3S6eHaAbCqw9dEUz7GRgVW06divLgkRnGQL/eym5dhyg6E0i3yMfyXfgl1pHuw54zBObm1ojs4CdXmeqbnRrkB2YrYSU7b97KEOWt43uEArWs9K0DTsj7tmEvdmIEn5iI1+T0XKKuCYEzFTeKotUp1MIhqWz6sFqkSnqfu0yOyGDYMHS9QiNKNLB+XnIPq1Wq8W3sVLl2qWTsFfSQ/K4/nA4ofbJ8nH9QC2S5TApzUgfhEZLgUA/xpLjBLEvvKRwspxheMjRUuey3kZPtlW0uINjZtwpqCWYXxprUpbxmPmMy/kRb3wMTQfhGM8ryJ/fiD/ZvYtl/M6ApWVAxqccCrMFHNJXm1vY03tKNm3RSUK/k7wH28rOaRxg3ztVkOwZzqu99iet1fa3vdojKDsO5YQ6ZO/xGafD/nhn9KPci+iL52Wqpy2eOGNmPynUNiUaVZmbcIMC65wMaIAO8ee2LSBk1YkNyRJEcAcvRQ7szrTaDjrcKWNm0dA4hCIFo3uO905ZoB0jHojeRVUwaxeMEmhfUNYKipB5RuTKL0IS+Qz/41mM9c6mmTqOWqsKTI2XiMZSx1JICx4Cez8nFRadnMmi5MyutLa/OzDuFLSxi+hrtPoopK5E9Jn3L3UsSes= Signed-off-by: Fernando Fernández <ferferga@hotmail.com>		2024-06-23 01:25:35 +02:00
.devcontainer	chore(devcontainer): use latest docker-compose	2024-05-03 12:08:33 +00:00
.github	chore(deps): update docker/build-push-action action to v6.1.0 (#2380 )	2024-06-22 21:14:28 +00:00
.vscode	refactor(vue-router): remove vue-router/auto usage	2024-06-21 18:18:49 +02:00
frontend	refactor(JSafeHtml): use createVNode	2024-06-23 01:25:35 +02:00
packaging	chore(deps): pin dependencies (#2386 )	2024-06-22 21:25:00 +00:00
.gitattributes	chore: don't treat cargo.lock as a binary file	2023-12-30 16:50:56 +01:00
.gitignore	chore: organize file structure	2023-10-24 10:03:12 +00:00
.npmrc	chore: re-enable npm fund	2024-02-21 23:54:49 +01:00
LICENSE	feat: add initial Nuxt template	2020-09-02 20:48:53 +02:00
package-lock.json	chore(deps): update npm development dependencies (major) (#2375 )	2024-06-22 23:36:40 +02:00
package.json	chore(deps): upgrade to node 20 LTS	2023-10-24 10:03:21 +00:00
README.md	chore(readme): add :unstable to docker run (#2218 )	2024-01-24 21:02:39 +01:00

Jellyfin Vue

Part of the Jellyfin Project

This is an alternative client for Jellyfin based on Vue.js. It might not be feature complete and it's constantly evolving.

Usage instructions for end users 👨‍👩‍👧‍👦

The following instructions will get you up and running quickly with bleeding-edge builds from the current master branch. There are no stable releases yet.

Hosted instance 🌍

Hosted by Cloudflare Pages.

⚠️ This only works for Jellyfin servers that are behind a reverse proxy and have HTTPS set up correctly. If your server runs over HTTP, you must use another deployment type.

Docker Container 📦

You can run the Docker container with the following command, replacing 8080 with the port of your choice:

docker run -d -p 8080:80 ghcr.io/jellyfin/jellyfin-vue:unstable

You can check GitHub Packages (GHCR) (recommended) or DockerHub for all the tagged images.

Other means 💽

There are more ways to host Jellyfin Vue yourself. Check our wiki page 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.

Read more

Local instances Examples: Our Windows/Mac/Linux application, a local web server, etc: All the necessary assets for the frontend to work are available locally (in your device) or bundled into the underlying environment (Tauri, Electron, etc) where it is running. No assets need to be fetched remotely.
Remote instances Examples: Our hosted instance, an admin hosting Jellyfin Vue and sharing the URL (which is in a different domain from the Jellyfin Server), etc: This probably comprises most cases. Here, all the frontend assets are not locally available, but somewhere else. When you access the remotely hosted frontend (normally using a web browser like Firefox or Microsoft Edge), all the frontend assets are loaded/cached into your device. Once the load has finished, the connection will exclusively be between your device and the Jellyfin server(s) ¹². Whoever is serving the frontend is never in the middle. ³

¹ Assuming that the hosted version has not been altered (by adding trackers, beacons...) in any way from the sources provided in this repository and you trust the person/people behind it to not have done so.

² Some features that need access to remote resources that are not controlled by you and/or the person hosting Jellyfin Vue might be added in the future (such as Google Cast support for Chromecasts). These will be always opt in and toggleable through our configuration

³ We assume standard networks here, no special configurations or policies that your ISP/Workplace/University/etc might apply.

Jellyfin Web (our main frontend) works in a similar way: It connects by default to the Jellyfin server that is running alongside, but it's also capable to connect to other Jellyfin servers like can be tested in our demo and the hosted instance. By inspecting the network requests, you will find that only connections to fetch its own assets are made to the server distributing the client, but connections to your own Jellyfin server will not go through it.

The same principel applies to Jellyfin Vue. Note that Jellyfin Web can also be hosted standalone, just like Jellyfin Vue.

Relevant links: Community standards and Social Contract

Usage instructions for developers 🛠

See development setup from our Contributing guides.

Contributing 🤝

See Contributing guide.

README.md