---
title: Subsonic
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 SubsonicConfig from '!!raw-loader!@site/../config/subsonic.json.example';

This Source can be used for any application that implements the [Subsonic API](http://www.subsonic.org/pages/api.jsp) and supports the [`getNowPlaying`](http://www.subsonic.org/pages/api.jsp#getNowPlaying) endpoint (such as [Airsonic](https://airsonic.github.io/) and [Navidrome](https://www.navidrome.org/))

<DetailsAdmo type="warning" summary="Known Issues">

* Multiple artists are reported as one value and cannot be separated
* If using [Airsonic Advanced](https://github.com/airsonic-advanced/airsonic-advanced) the password used (under **Credentials**) must be **Decodable**

</DetailsAdmo>

<DetailsAdmo type="tip" summary="Recommended Alternative Sources">

If your serivce supports scrobbling to **Listenbrainz** (such as Navidrome), considering using a [**Listenbrainz (Endpoint)** Source](/configuration/sources/listenbrainz-endpoint) instead of this one.

Service-specific scrobble implementations tend to be more accurate and provide more information (multiple artists) compared to the Subsonic API.

</DetailsAdmo>

Use the optional `usersAllow` property with **File** or **AIO** configuration to restrict scrobbling to a list of defined users.

## Configuration

<Config config="SubSonicSourceConfig" fileContent={SubsonicConfig} name="subsonic">
        | Environmental Variable | Required? | Default | Description                          |
        | ---------------------- | --------- | ------- | ------------------------------------ |
        | `SUBSONIC_ID`          | Yes       |         | A unique ID                          |
        | `SUBSONIC_USER`        | Yes       |         |                                      |
        | `SUBSONIC_PASSWORD`    | Yes       |         |                                      |
        | `SUBSONIC_URL`         | Yes       |         | Base url of your subsonic-api server |
        | `SUBSONIC_NAME`        | No        |         | A vanity name different than ID      |
</Config>