https://github.com/jsclayton/sidecarr

Helps manage your Plex automations
https://github.com/jsclayton/sidecarr

lidarr plex radarr sonarr

Last synced: 10 days ago
JSON representation

Helps manage your Plex automations

• Host: GitHub
• URL: https://github.com/jsclayton/sidecarr
• Owner: jsclayton
• License: mit
• Created: 2021-08-07T22:18:16.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-08-10T22:47:08.000Z (over 3 years ago)
• Last Synced: 2024-08-01T12:29:20.906Z (3 months ago)
• Topics: lidarr, plex, radarr, sonarr
• Language: TypeScript
• Homepage:
• Size: 395 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Sidecarr



	



Sidecarr lives alongside your Plex Media Server and automation tools to help curate your media collection.

- Integrates with [Radarr](https://radarr.video/), [Sonarr](https://sonarr.tv/), and [Lidarr](https://lidarr.audio/)

- Trigger Plex scans only on directories with changes

- Post playback notifications to Slack

## Docker Compose Quick Start

```

version: '3.4'

services:

  sidecarr:

    image: ghcr.io/jsclayton/sidecarr:latest

    environment:

      SIDECARR_BASE_URL: 'https://sidecarr.myflix.com'

      SIDECARR_PMS_BASE_URL: 'http://plex:32400'

      SIDECARR_PMS_TOKEN: '{YOUR PLEX TOKEN}'

      SIDECARR_SLACK_WEBHOOK_URL: '{YOUR SLACK WEBHOOK URL}'

```

| Environment Variable | Description |

| --- | --- |

| `SIDECARR_BASE_URL` | The publicly accessible URL where Sidecarr can be reached at. This is used by Slack to access thumbnail images. Not needed if you don't configure Slack notification. |

| `SIDECARR_PMS_BASE_URL` | The URL that your PMS can be reached at, relative to the Sidecarr instance. If you are running PMS within the same Docker instance you can use the container name to access it. |

| `SIDECARR_PMS_TOKEN` | [Your PMS token.](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/) |

| `SIDECARR_SLACK_WEBHOOK_URL` | [Your Slack webhook URL.](https://api.slack.com/messaging/webhooks) |