Jellyfin Vue
---
---
This is an alternative client for Jellyfin based on Vue.js. It might not be feature complete and it's constantly evolving.
# For end users ๐จโ๐ฉโ๐งโ๐ฆ
## [Hosted instance ๐](https://jf-vue.pages.dev/)
Our hosted instance points to a version built from the current `master` branch. Hosted by CloudFlare Pages.
## Docker Container ๐ฆ
You can run the Docker container with the following command, replacing 8080 with the port of your choice:
```bash
docker run -d -p 8080:80 ghcr.io/jellyfin/jellyfin-vue
```
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 _frontend_ for a Jellyfin server. It only establishes connection to the Jellyfin server that you point it to, **nothing else**.
- **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](https://github.com/jellyfin/jellyfin-vue/wiki/Configuration)_
ยณ _We assume standard networks here, no special configurations or policies that your ISP/Workplace/University/etc might apply._
For your interest, [Jellyfin Web](https://github.com/jellyfin/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](https://demo.jellyfin.org/) and,
once loaded, only connections to fetch its own assets are made to the original server. Jellyfin Web can also be hosted standalone like Jellyfin Vue.
- _Relevant links_: [Community standards](https://jellyfin.org/docs/general/community-standards) and [Social Contract](https://github.com/jellyfin/jellyfin-meta/blob/master/policies-and-procedures/jellyfin-social-contract.md)
# For developers ๐
## Dependencies
- [Node.js LTS](https://nodejs.org/en/download) `>=18.12.0 <19.0.0`
- npm `>=8.19.2` (included in Node.js)
- Jellyfin Server `>=10.7.0`
## Getting Started
1. Clone or download this repository:
```bash
git clone https://github.com/jellyfin/jellyfin-vue.git
cd jellyfin-vue
```
2. Install the build dependencies in the project directory:
```bash
npm install
```
3. Run development build:
```bash
npm start
```
The client will be available at by default.
### Build for production ๐๏ธ
When you're ready to deploy the client, you must build it for production specifically:
```bash
npm run build
```
Build output will be available under the `src/dist` folder.
## Other build features ๐๏ธ
### Running a production build
After building the client, you can serve it directly:
```bash
npm run serve
```
There's also a shortcut for building the production version of the client and serving it afterwards:
```bash
npm run prod
```
โ ๏ธ _Although the build of the client is production-ready, the internal HTTP server should never be exposed directly to the internet and a proper webserver like Nginx should always be used instead._
## Contributing ๐ค
### Translations ๐
Head over [our translation platform](https://translate.jellyfin.org/projects/jellyfin-vue/jellyfin-vue/)
### Code ๐งฎ
We follow the **[fork and PR](https://docs.github.com/en/get-started/quickstart/contributing-to-projects)** paradigm.
We welcome all contributions and pull requests!
If you have larger changes in mind, split them up in smaller PRs as much as possible.
You can also open a GitHub Discussion or reach with us in Matrix to talk about the implementation details or the review process.
For more information, see [our contributing guide](https://github.com/jellyfin/jellyfin-vue/wiki/Contributing)
### Donations ๐ฐ
You can help the Jellyfin project as a whole pay for server and API expenses through our [OpenCollective](https://opencollective.com/jellyfin).
If you want to strictly donate to the developers of Jellyfin Vue, check [our top contributors](https://github.com/jellyfin/jellyfin-vue/graphs/contributors) and sponsor whoever you want.
The maintainers/leaders of the development of every Jellyfin project (including Jellyfin Vue) are listed [here](https://github.com/jellyfin/jellyfin-meta/blob/master/jellyfin-team.md#subproject-leaders).