Installation and utilization

Welcome to this short Wiki page explaining the installation of Emby-Recap.

Software information and dependencies

Emby recap is written in Deno utilizing the Fresh framework. (For the uninitiated, Deno is a secure next-gen runtime for JavaScript applications). The project is released as a Docker container but can be run with Deno directly.

This application uses the Emby Replay Reporting plugin. This plugin only starts collecting user data after its installation.

Installation

Example run commands are available in the Readme.md file. The following environment variables are required:

EMBY_URL: "http://localhost:8096" # URL for your Emby instance, (without a slash at the end)
EMBY_API_KEY: "ADMIN_ACCOUNT_TOKEN" # Token for an administrator account (see known issues)

Known issues

Emby API key doesn't have enough privileges

A Emby API key generated through the admin dashboard isn't able to access the playback reporting plugin's data. As a workaround, create a new admin user in Emby and copy the X-Emby-Token of that user. This token is obtainable through the following method:

Getting the X-Emby-Token from an admin user

1. Login in as the admin user
2. Navigate to the playback reporting plugin dashboard
3. Open the network inspection tab from your browser (F12 > navigate to Network)
4. Enable the XHR filter for easier debugging
5. Click on the "Active" tab inside of the playback reporting dashboard
6. Click on the session_list GET request shown in the network inspector
7. Copy the X-Emby-Token shown in the headers of the request.