mirror of
https://github.com/FoxxMD/multi-scrobbler.git
synced 2026-05-01 05:09:54 +00:00
67 lines
No EOL
3.9 KiB
Text
67 lines
No EOL
3.9 KiB
Text
---
|
|
title: Jellyfin
|
|
toc_min_heading_level: 2
|
|
toc_max_heading_level: 5
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
import CodeBlock from '@theme/CodeBlock';
|
|
import JellyfinConfig from '!!raw-loader!@site/../config/jellyfin.json.example';
|
|
|
|
Must be using Jellyfin 10.7 or greater
|
|
|
|
* Create an **API Key** for multi-scrobbler
|
|
* In the Jellyfin desktop web UI Navigate to -> Administration -> Dashboard -> API Keys (`http://YOUR_JELLYIN_URL/web/index.html#!/apikeys.html`)
|
|
* Click `+` button and create a new key with **App name** `multi-scrobbler`
|
|
* Copy the created API Key value for use in configuration below
|
|
|
|
|
|
It is **recommended** to use API Key + username but if you are not an admin for your Jellyfin instance you can also authenticate with your Jellyfin username and **password.**
|
|
|
|
<DetailsAdmo type="tip" summary="Important Defaults">
|
|
|
|
By default...
|
|
|
|
* multi-scrobbler will **only** scrobble for the user authenticated with the API.
|
|
* Allowed Users (`usersAllow` or `JELLYFIN_USERS_ALLOW`) are only necessary if you want to scrobble for additional users.
|
|
* multi-scrobbler will **only** scrobble media found in Jellyfin libraries that were labelled as **Music.**
|
|
* `librariesAllow` or `JELLYFIN_LIBRARIES_ALLOW` will override this
|
|
* OR use `additionalAllowedLibraryTypes` to allow more types (like `mixed` or `book` for audiobooks)
|
|
* multi-scrobbler will **only** scrobble media Jellyfin detects as **Audio.**
|
|
* To force multi-scrobbler to scrobble when media is detected as **Unknown** use `"allowUnknown": true` in file/aio configuration.
|
|
|
|
</DetailsAdmo>
|
|
|
|
#### Configuration
|
|
|
|
<Tabs groupId="configType" queryString>
|
|
<TabItem value="env" label="ENV">
|
|
| Environmental Variable | Required? | Default | Description |
|
|
| -------------------------- | --------- | ------- | ------------------------------------------------------------------------------------------ |
|
|
| `JELLYFIN_URL` | **Yes** | | The URL of the Jellyfin server IE `http://localhost:8096` |
|
|
| `JELLYFIN_USER` | **Yes** | | The user to authenticate with the API |
|
|
| `JELLYFIN_APIKEY` | No | | The API Key to use for authentication **(Must provide either apikey or password)** |
|
|
| `JELLYFIN_PASSWORD` | No | | The password of the user to authenticate for. **(Must provide either apikey or password)** |
|
|
| `JELLYFIN_USERS_ALLOW` | No | | Comma-separated list of usernames (from Jellyfin) to scrobble for |
|
|
| `JELLYFIN_USERS_BLOCK` | No | | Comma-separated list of usernames (from Jellyfin) to disallow scrobble for |
|
|
| `JELLYFIN_DEVICES_ALLOW` | No | | Comma-separated list of devices to scrobble from |
|
|
| `JELLYFIN_DEVICES_BLOCK` | No | | Comma-separated list of devices to disallow scrobbles from |
|
|
| `JELLYFIN_LIBRARIES_ALLOW` | No | | Comma-separated list of libraries to allow scrobbles from |
|
|
| `JELLYFIN_LIBRARIES_BLOCK` | No | | Comma-separated list of libraries to disallow scrobbles from |
|
|
</TabItem>
|
|
<TabItem value="file" label="File">
|
|
|
|
<CodeBlock title="CONFIG_DIR/jellyfin.json" language="json5">{JellyfinConfig}</CodeBlock>
|
|
|
|
or <SchemaLink lower objectName="JellyApiSourceConfig"/>
|
|
|
|
</TabItem>
|
|
<TabItem value="aio" label="AIO">
|
|
|
|
<AIOExample data={JellyfinConfig} name="jellyfin"/>
|
|
|
|
|
|
or <SchemaLink lower objectName="JellyApiSourceConfig"/>
|
|
</TabItem>
|
|
</Tabs> |