1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/jellyfin_ynh.git synced 2024-09-03 19:26:29 +02:00
jellyfin_ynh/README.md
2023-04-23 15:01:56 -06:00

64 lines
2.8 KiB
Markdown

<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
# Jellyfin for YunoHost
[![Integration level](https://dash.yunohost.org/integration/jellyfin.svg)](https://dash.yunohost.org/appci/app/jellyfin) ![Working status](https://ci-apps.yunohost.org/ci/badges/jellyfin.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/jellyfin.maintain.svg)
[![Install Jellyfin with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jellyfin)
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install Jellyfin quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
Jellyfin enables you to collect, manage, and stream your media. Run the Jellyfin server on your system and gain access to the leading free-software entertainment system, bells and whistles included.
**Shipped version:** 10.8.10~ynh1
**Demo:** https://demo.jellyfin.org/stable/web/index.html
## Screenshots
![Screenshot of Jellyfin](./doc/screenshots/jellyfin.png)
## Disclaimers / important information
* The app relies on YunoHost's LDAP server for users to log in:
* Standard users need the `main` permission;
* Users with the `admin` permission will have access to the administration panel.
* The app can access YunoHost's multimedia directories:
choose one of the folders in `/home/yunohost.multimedia/share` upon configuration of your libraries.
* Starting version 10.7.5~ynh2, you can ask for the discovery ports (1900 and 7359) to be opened.
They ease the setting up of your media center between clients and server.
* If you are upgrading to this version and above, set `discovery: '1'` in `/etc/yunohost/apps/jellyfin/settings.yml`
if you want the upgrade to open them for you.
## Documentation and resources
* Official app website: <https://jellyfin.org>
* Official user documentation: <https://jellyfin.org/docs/>
* Upstream app code repository: <https://github.com/jellyfin/jellyfin>
* YunoHost documentation for this app: <https://yunohost.org/app_jellyfin>
* Report a bug: <https://github.com/YunoHost-Apps/jellyfin_ynh/issues>
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/jellyfin_ynh/tree/testing).
To try the testing branch, please proceed like that.
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/jellyfin_ynh/tree/testing --debug
or
sudo yunohost app upgrade jellyfin -u https://github.com/YunoHost-Apps/jellyfin_ynh/tree/testing --debug
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>