For the correct operation of the module, a pre-prepared Jellyfin installation is required (the module does not assist in the installation of the Jellyfin server and assumes that such installation is ready for operation through API.) Module use Jellyfin API to manage clients account.
We have prepared a detailed installation manual for the module, including all the steps needed to implement the module, including the preparation of the Jellyfin server, including all installation steps such as PHP, Jellyfin, SSL certificates etc.
**Requirements:** WISECP: v3.1.5+, php: v8.x, Ioncube: V12+ Jellyfin: v10+
### Functions: - Auto create and deploy client account - The module uses only the API to manage the accounts - Module supports multilingualism **(Arabic, Bosnian, Czech, German, Greek, English, Spanish, Persian, French, Hungarian, Indonesian, Italian, Georgian, Latvian, Dutch, Polish, Portuguese, Romanian, Ukrainian)** - The module shows all user info: enabled user libraries, active devices etc. - Link to instructions for setting up the service in the client area. ### Available options in the admin panel: - Create users - Suspend users - Terminate users - Unsuspend users - Change users password - Change Package - Drop all devices - Unblock user - API connection status - List of active devices - List of enabled user libraries ### Available options in the client panel: - List of active devices - List of enabled user libraries - Drop all devices - Unblock user - Change the Jellyfin user password ##### Screenshot of the Client area [](https://doc.puq.info/uploads/images/gallery/2024-07/image-1720437792545.png) ##### Screenshot of the Admin area [](https://doc.puq.info/uploads/images/gallery/2024-07/image-1720442240169.png)To install and update a module, you must perform one and the same action.
##### ##### 1. Download the latest version of the module. ```Powershell wget http://download.puqcloud.com/WISECP/Product/PUQ_WISECP-Jellyfin/PUQ_WISECP-Jellyfin-latest.zip ```All versions are available: [https://download.puqcloud.com/WISECP/Product/PUQ\_WISECP-Jellyfin/](https://download.puqcloud.com/WISECP/Product/PUQ_WISECP-Jellyfin/)
##### ##### 2. Unzip the archive with the module. ```Powershell unzip PUQ_WISECP-Jellyfin-latest.zip ``` ##### ##### 3. Copy and Replace "puqJellyfin" from "PUQ\_WISECP-Jellyfin" to "WISECP\_WEB\_DIR/coremio/modules/Product/" # License Activation ### Jellyfin module **[WISECP](https://puqcloud.com/link.php?id=78)** ##### [Order now](https://puqcloud.com/index.php?rp=/store/wisecp-module-jellyfin) | [Download](https://download.puqcloud.com/WISECP/Product/PUQ_WISECP-Jellyfin/) | [FAQ](https://faq.puqcloud.com/) ##### 1. Log in to the administrative area of your **[WISECP](https://puqcloud.com/link.php?id=78)**. ##### 2. Go to module configuration. ``` Services -> Service Management -> Module Settings -> Other -> All Modules -> PUQ Jellyfin ``` [](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700485721333.png) [](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700485726951.png) [](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700485737918.png) [](https://doc.puq.info/uploads/images/gallery/2023-12/1.png) [](https://doc.puq.info/uploads/images/gallery/2023-12/2.png) # Setup guide: Jellyfin setup ### Jellyfin module **[WISECP](https://puqcloud.com/link.php?id=78)** ##### [Order now](https://puqcloud.com/index.php?rp=/store/wisecp-module-jellyfin) | [Download](https://download.puqcloud.com/WISECP/Product/PUQ_WISECP-Jellyfin/) | [FAQ](https://faq.puqcloud.com/) #### 1. Install Jellyfin on your server To simplify deployment and help automate this for as many users as possible, we provide a BASH script to handle repo installation as well as installing Jellyfin. All you need to do is run this command on your system ``` wget -O- https://repo.jellyfin.org/install-debuntu.sh | sudo bash ``` #### 2. SSL certificate generation: ``` sudo apt install nginx certbot python3-certbot-nginx ``` ``` sudo certbot --nginx --agree-tos --redirect --hsts --staple-ocsp --email YOUR_EMAIL -d DOMAIN_NAME ``` ``` echo "0 0 * * * root certbot renew --quiet --no-self-upgrade --post-hook 'systemctl reload nginx'" | sudo tee -a /etc/cron.d/renew_certbot ``` #### 3. Configure nginx from a subdomain Create a file named jellyfin.conf. ``` cd /etc/nginx/conf.d/ nano jellyfin.conf ``` Then, insert the following text, replacing DOMAIN\_NAME with your domain. ```Nginx # Uncomment the commented sections after you have acquired a SSL Certificate server { listen 80; listen [::]:80; server_name DOMAIN_NAME; # Uncomment to redirect HTTP to HTTPS return 301 https://$host$request_uri; } server { listen 443 ssl http2; listen [::]:443 ssl http2; server_name DOMAIN_NAME; ## The default `client_max_body_size` is 1M, this might not be enough for some posters, etc. client_max_body_size 20M; # use a variable to store the upstream proxy # in this example we are using a hostname which is resolved via DNS # (if you aren't using DNS remove the resolver line and change the variable to point to an IP address e.g `set $jellyfin 127.0.0.1`) set $jellyfin 127.0.0.1; resolver 127.0.0.1 valid=30; ssl_certificate /etc/letsencrypt/live/DOMAIN_NAME/fullchain.pem; ssl_certificate_key /etc/letsencrypt/live/DOMAIN_NAME/privkey.pem; include /etc/letsencrypt/options-ssl-nginx.conf; ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; add_header Strict-Transport-Security "max-age=31536000" always; ssl_trusted_certificate /etc/letsencrypt/live/DOMAIN_NAME/chain.pem; ssl_stapling on; ssl_stapling_verify on; # Security / XSS Mitigation Headers # NOTE: X-Frame-Options may cause issues with the webOS app add_header X-Frame-Options "SAMEORIGIN"; add_header X-XSS-Protection "0"; # Do NOT enable. This is obsolete/dangerous add_header X-Content-Type-Options "nosniff"; # COOP/COEP. Disable if you use external plugins/images/assets add_header Cross-Origin-Opener-Policy "same-origin" always; add_header Cross-Origin-Embedder-Policy "require-corp" always; add_header Cross-Origin-Resource-Policy "same-origin" always; # Permissions policy. May cause issues on some clients add_header Permissions-Policy "accelerometer=(), ambient-light-sensor=(), battery=(), bluetooth=(), camera=(), clipboard-read=(), display-capture=(), document-domain=(), encrypted-media=(), gamepad=(), geolocation=(), gyroscope=(), hid=(), idle-detection=(), interest-cohort=(), keyboard-map=(), local-fonts=(), magnetometer=(), microphone=(), payment=(), publickey-credentials-get=(), serial=(), sync-xhr=(), usb=(), xr-spatial-tracking=()" always; # Tell browsers to use per-origin process isolation add_header Origin-Agent-Cluster "?1" always; # Content Security Policy # See: https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP # Enforces https content and restricts JS/CSS to origin # External Javascript (such as cast_sender.js for Chromecast) must be whitelisted. # NOTE: The default CSP headers may cause issues with the webOS app #add_header Content-Security-Policy "default-src https: data: blob: http://image.tmdb.org; style-src 'self' 'unsafe-inline'; script-src 'self' 'unsafe-inline' https://www.gstatic.com https://www.youtube.com blob:; worker-src 'self' blob:; connect-src 'self'; object-src 'none'; frame-ancestors 'self'"; location = / { return 302 http://$host/web/; #return 302 https://$host/web/; } location / { # Proxy main Jellyfin traffic proxy_pass http://$jellyfin:8096; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; proxy_set_header X-Forwarded-Protocol $scheme; proxy_set_header X-Forwarded-Host $http_host; # Disable buffering when the nginx proxy gets very resource heavy upon streaming proxy_buffering off; } # location block for /web - This is purely for aesthetics so /web/#!/ works instead of having to go to /web/index.html/#!/ location = /web/ { # Proxy main Jellyfin traffic proxy_pass http://$jellyfin:8096/web/index.html; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; proxy_set_header X-Forwarded-Protocol $scheme; proxy_set_header X-Forwarded-Host $http_host; } location /socket { # Proxy Jellyfin Websockets traffic proxy_pass http://$jellyfin:8096; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "upgrade"; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; proxy_set_header X-Forwarded-Protocol $scheme; proxy_set_header X-Forwarded-Host $http_host; } } ``` #### Restarting nginx ``` sudo service nginx restart ``` # Add server (Jellyfin server) ### Jellyfin module **[WISECP](https://puqcloud.com/link.php?id=78)** ##### [Order now](https://puqcloud.com/index.php?rp=/store/wisecp-module-jellyfin) | [Download](https://download.puqcloud.com/WISECP/Product/PUQ_WISECP-Jellyfin/) | [FAQ](https://faq.puqcloud.com/) ##### 1. Log in to the administrative area of your **[WISECP](https://puqcloud.com/link.php?id=78)**. ##### 2. Go to module configuration. ``` Services -> Service Management -> Module Settings -> Other -> All Modules -> PUQ Jellyfin ``` [](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700485721333.png) [](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700485726951.png) [](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700485737918.png) [](https://doc.puq.info/uploads/images/gallery/2023-12/1.png) ##### 3. In the opened page, click the '**Add Server**' button. [](https://doc.puq.info/uploads/images/gallery/2023-12/3.png) ##### ##### 4. On the opened page, enter all the necessary information: - **Name**: Displayed name of the server. - **Maximum Number of Accounts**: The number of services that can be on this server. - **Server Group**: Optionally, choose the server group. - **IP Address or Domain**: The address of the Emby server you are connecting to. - **Username:** is the username for the account on [Jellyfin](https://jellyfin.org/). - **Password:** is the password for the account on [Jellyfin](https://jellyfin.org/). - **Access Hash**: API key that you created in the previous step on the Emby server. - Check the **SSL** box if you want to use SSL-encrypted connection. If necessary, specify the port and perform a connection test. [](https://doc.puq.info/uploads/images/gallery/2023-12/4.png) # Service configuration ### Jellyfin module **[WISECP](https://puqcloud.com/link.php?id=78)** ##### [Order now](https://puqcloud.com/index.php?rp=/store/wisecp-module-jellyfin) | [Download](https://download.puqcloud.com/WISECP/Product/PUQ_WISECP-Jellyfin/) | [FAQ](https://faq.puqcloud.com/)If you do not have a **Service Group** where you want to place the new service, you need to create a new **Service Group**
##### 1. Log in to the administrative area of your **[WISECP](https://puqcloud.com/link.php?id=78)**. ##### 2. Create New Service Group Go to ``` Services -> Service Management -> Add Group ``` [](https://doc.puq.info/uploads/images/gallery/2023-11/32b5.png) Enter all the necessary data and click the '**Create Group**' button. [](https://doc.puq.info/uploads/images/gallery/2023-11/yDd6.png) ##### 3. Adding a New Service Go to ``` Services -> our service group where you need to add the new service. ``` [](https://doc.puq.info/uploads/images/gallery/2023-11/Shg7.png) In the opened window, click the '**Create New Service**' button. [](https://doc.puq.info/uploads/images/gallery/2023-11/auQ8.png) On the opened page, enter all the necessary details for your new service and navigate to the '**Core**' tab. Select the '**PUQ Jellyfin**' module from the drop-down list of modules. [](https://doc.puq.info/uploads/images/gallery/2023-12/8Xj5.png) ##### 4. Fill in the configuration options according to your preferences. ##### Libraries: - **Use All Libraries**: Choosing all of libraries from your Jellyfin server - **Libraries**: The libraries you want to make available to customers of this product. **(IMPORTANT! Start a new line for each new library)** Example: "Movies Beginner`s Programming Course Comedy" **IMPORTANT!** If you have a folder named "-", please enter it not as the first one or rename it. If you don't want any folder to be accessible, type "-". ##### User Configuration: - **Streaming bitrate limit:** An optional per-stream bitrate limit for all out of network devices. This is useful to prevent devices from requesting a higher bitrate than your internet connection can handle. This may result in increased CPU load on your server in order to transcode videos on the fly to a lower bitrate. - **SyncPlay access:** The SyncPlay feature enables to sync playback with other devices. Select the level of access this user has to the SyncPlay - **Remote control:** Remote control of shared devices (DLNA devices are considered shared until a user begins controlling them) - **Media downloads:** Users can download media and store it on their devices. This is not the same as a sync feature. Book libraries require this enabled to function properly. - **User sessions:** Set the maximum number of simultaneous user sessions.After modifying the configuration options, check the '**Send changes to server**' box to save the data to the [Jellyfin](https://jellyfin.org/)server.
[](https://doc.puq.info/uploads/images/gallery/2023-12/8.png)