PUQ Mautic

Emby WHMCS module

This module enables your company to offer public media services to customers through Emby accounts. It facilitates the creation of customer accounts on a pre-configured Emby server, allowing for the sale of various media packages at different prices. The module requires a pre-installed Emby server and uses the Emby API for client account management. It also supports multiple languages. Administrators can suspend, terminate, or unsuspend users, change user passwords, and more, while clients can manage their devices and libraries. Starting from version v1.3, the module supports Emby Connect functionality.

Description

Emby module WHMCS 

 Order now | Download | FAQ

Thanks to the module, the company is able to offer public media services to its customers based on Emby accounts.

The module is used to create customer accounts on the previously prepared Emby server. The module enables You to define multiple public media packages and sell them at different prices. The module creates a customer account according to the selected package. The client can have many independent accounts in the media.

Moreover, the module seamlessly integrates with Emby Connect functionality, enabling users to access their media accounts across different devices and platforms with ease.

For the correct operation of the module, a pre-prepared Emby installation is required (the module does not assist in the installation of the Emby server and assumes that such installation is ready for operation through API.) Module use Emby 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 Emby server, including all installation steps such as PHP, Emby , SSL certificates etc.

Functions:

Available options in the admin panel:

Available options in the client panel:

WHMCS minimal version: 8 +

Emby minimal version: 4.7+

image-1720696798608.png

 

image-1715068372834.png

Changelog

Emby module WHMCS 

 Order now | Download | FAQ
v2.0 Released 24-09-2024

Module is coded ionCube v13

Supported php version:

v1.4.1 Released 13-08-2024

  1. Fixed bug with password, when "Show password" is "no"
v1.4 Released 12-07-2024
  1. Buttons for copying login and password have been added to the client area
  2. Client area more adapted for mobile version
  3. New module settings: 
    • Subtitle Downloading
    • Camera upload
    • Media conversion
    • Social media sharing
    • User Preference Access

v1.3 Released 07-05-2024

  1. Added the capability to link an Emby Connect Username to the account.
  2. Introduced a new tab for managing Emby Connect Username in the Client Area.
  3. Optimized.
v1.2 Released 21-12-2023

Client Area Enhancements:

  1. Added the ability to disable the display of service passwords by default.
  2. Introduced a "Show" button for displaying service passwords in the Client Area.
  3. Provided options to display service passwords in plain text.

You should save the 'Module Setting' in your products for the module to function correctly.

v1.1 Released 20-11-2023
  1. Fixed bug with incorrect libraries selection functionality, CRITICAL
  2. Fix some bugs in the change password feature.
  3. New "Use All Libraries" checkbox in Module Setting page.
  4. Some change in Client Area.
  5. Optimized

You should reconfigure the 'Module Setting' in your product for the module to function correctly. Additionally, it's recommended to select 'Change Package' in the customer product settings."

v1.0 Released 10-11-2023

First version

Installation and configuration guide

Installation and configuration guide

WHMCS setup(install/update)

Emby module WHMCS 

 Order now | Download | FAQ

Module is coded ionCube v13

Supported php version:

To install and update a module, you must perform one and the same action.

1. Download the latest version of the module.

PHP 8.2

wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Emby/php82/PUQ_WHMCS-Emby-latest.zip

PHP 8.1

wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Emby/php81/PUQ_WHMCS-Emby-latest.zip

PHP 7.4

wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Emby/php74/PUQ_WHMCS-Emby-latest.zip

All versions are available via link: http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Emby/

2. Unzip the archive with the module.
unzip PUQ_WHMCS-Emby-latest.zip
3. Copy and Replace "puqEmby" to "WHMCS_WEB_DIR/modules/servers/"
Installation and configuration guide

Setup guide: Emby setup

Emby module WHMCS 

 Order now | Download | FAQ

1. Install Emby 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 Emby. All you need to do is run this command on your system

wget https://github.com/MediaBrowser/Emby.Releases/releases/download/4.7.14.0/emby-server-deb_4.7.14.0_amd64.deb
dpkg -i emby-server-deb_4.7.14.0_amd64.deb

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 nginx.conf.

cd /etc/nginx/conf.d/
nano nginx.conf

Then, insert the following text, replacing DOMAIN_NAME with your domain.

# 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 302 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 $emby 127.0.0.1`)
        set $emby 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 Emby traffic
                proxy_pass http://$emby: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 Emby traffic
                proxy_pass http://$emby: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 Emby Websockets traffic
                proxy_pass http://$emby: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
Installation and configuration guide

Setup guide: WHMCS setup

Emby module WHMCS 

 Order now | Download | FAQ
1. Download the latest version of the module.

PHP 8.1

wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Emby/PUQ_WHMCS-Emby-latest.zip

PHP 7.4

wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Emby/php74/PUQ_WHMCS-Emby-latest.zip

All versions are available via link: http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Emby/

2. Unzip the archive with the module.
unzip PUQ_WHMCS-Emby-latest.zip
3. Copy "puqEmby" to "WHMCS_WEB_DIR/modules/servers/"
4. Create new server Emby in WHMCS (System Settings->Products/Services->Servers)
System Settings->Servers->Add New Server

21.png

22.png

5. Create a new Products/Services
System Settings->Products/Services->Create a New Product

In the Module settings section, select the "PUQ Emby" module

image-1720697359086.png

Libraries:
User Configuration:
Allow playback (Restricting access to transcoding may cause playback failures in clients due to unsupported media formats)
Feature access:
Installation and configuration guide

Add server (Emby server)

Emby module WHMCS 

 Order now | Download | FAQ
Add a new server to the system WHMCS.
System Settings->Servers->Add New Server

21.png

22.png

Installation and configuration guide

Product Configuration

Emby module WHMCS 

 Order now | Download | FAQ
Create a new Products/Services
System Settings->Products/Services->Create a New Product

In the Module settings section, select the "PUQ Emby" module

image-1720697533136.png

 

Libraries:
User Configuration:
Allow playback (Restricting access to transcoding may cause playback failures in clients due to unsupported media formats)
Feature access:
Installation and configuration guide

Add new library/item in Emby

Emby module WHMCS 

 Order now | Download | FAQ

New library:

To create a new library, you should to create a folder in your Emby server.

First, navigate to the root of your project "/" and enter the following commands:

cd mnt
mkdir LIBRARY_NAME

LIBRARY_NAME - The name of the new library. 

After creating a folder, let's create a library in Emby: 

Add a new library:

9.png

Assign the appropriate folder to this library:

11.png

12.png

 

New item:

To download a new item, navigate to the root of your project "/" and enter the following commands:

cd mnt/LIBRARY_NAME
wget DOWNLOAD_ITEM_URL

LIBRARY_NAME - The name of the library. 

DOWNLOAD_ITEM_URL - The download URL of the item you want to upload to the server.

 

After all

Scan all libraries by clicking on the "Scan All Libraries" button, or scan the specific library by clicking on the three dots and selecting "Scan Library."

13.png14.png

 

Installation and configuration guide

Getting Access Hash (API key)

Emby module WHMCS 

 Order now | Download | FAQ
Dashboard -> API Keys
Create a new API Key

15.png

 

Whrite an App Name

16.png

 

Now you can getting an API key

17.png

Client Area

Client Area

Home screen

Emby module WHMCS 

 Order now | Download | FAQ

The end customer, after logging in to his own customer panel, has access to the following information and options

image-1720697559223.png

 

Client Area

Manage Emby Connect

Emby module WHMCS 

 Order now | Download | FAQ

Here you can add an Emby Connect Username for main user

If you leave the field empty, Emby Connect will be disabled.

Register the email in Emby Connect. 

One Emby Connect username can only be linked to one Emby account.

image-1715068747830.png

image-1714752317890.png

Admin Area

Admin Area

Product Information

Emby module WHMCS 

 Order now | Download | FAQ
Here is the data presented for the service admin in WHMCS

image-1715068669459.png