Repository files navigation

Your media enjoyed with a minimal lightweight media server

Free and open source (and always will be),Midarr aims to provide a tailored experience foryou andyourusers:

• Beautifully crafted user interface
• Real-time online statuses
• Simple and easy invite system
• Integrates with your existing services,Radarr andSonarr

This is a lightweight (albeit companion) media server to the likes of Radarr and Sonarr.Your media is left untouched and unscathed as it is served through a simple (yet familiar) web interface that puts your media front and center foryou andyour users to enjoy.

While other media solutions look to re-index, re-fetch and re-double handle your media library, Midarr simply leverages your pre-existingservices to delight and enhanceyour media experience.

• Direct streaming. Your media served fresh off the metal.
• Smart caching. Your media smartly kept in sync with your integrations.
• Integrated experience. Your media kept the way you like it.

Your media is served through a slick web interface providing:

• User authentication
• User profile settings
• User online statuses

with more features planned ahead.

volumes:database-data:services:midarr:container_name:midarrimage:ghcr.io/midarrlabs/midarr-server:latestports:      -4000:4000volumes:      -/path/to/media:/mediaenvironment:#       App config      -APP_URL=http://midarr:4000#       Database config      -DB_USERNAME=my_user      -DB_PASSWORD=my_password      -DB_DATABASE=my_database      -DB_HOSTNAME=postgresql#       Admin account      -SETUP_ADMIN_EMAIL=admin@email.com      -SETUP_ADMIN_NAME=admin      -SETUP_ADMIN_PASSWORD=somepassword# minimum length 12#       Radarr integration      -RADARR_BASE_URL=radarr:7878      -RADARR_API_KEY=someApiKey#       Sonarr integration      -SONARR_BASE_URL=sonarr:8989      -SONARR_API_KEY=someApiKeydepends_on:postgresql:condition:service_healthypostgresql:container_name:postgresqlimage:postgresvolumes:      -database-data:/var/lib/postgresql/dataenvironment:      -POSTGRES_USER=my_user      -POSTGRES_PASSWORD=my_password      -POSTGRES_DB=my_databasehealthcheck:test:"exit 0"

To initialise this, please provide the followingenvironment variables. This will allow you to configure your server at thesettings page.

environment:  -SETUP_ADMIN_EMAIL=admin@email.com  -SETUP_ADMIN_NAME=admin  -SETUP_ADMIN_PASSWORD=somepassword# minimum length 12

To send invitations, please provide the followingenvironment variables. Access thesettings page to invite users to your server.

environment:  -APP_MAILER_FROM=example@email.com  -SENDGRID_API_KEY=someApiKey

To use your own identity provider likeAuthentik, please provide the followingenvironment variables. Go to/auth to initiate the auth flow.

environment:  -OAUTH_CLIENT_ID=someClientId  -OAUTH_CLIENT_SECRET=someClientSecret  -OAUTH_ISSUER_URL=http://some-provider.url  -OAUTH_AUTHORIZE_URL=http://some-provider.url/authorize  -OAUTH_TOKEN_URL=http://some-provider.url/token  -OAUTH_REDIRECT_URI=http://some-provider.url/auth/callback  -OAUTH_USER_URL=http://some-provider.url/user

• H.264 / H.265 codec
• AAC / MP3 audio
• MP4 / MKV container

Midarr looks to your integrations to resolve your media locations. Midarris not aware of where your media lives!A common way to mount a media library is to mount the root directory where both movies and series reside:

services:midarr:volumes:      -/path/to/media:/mediaradarr:volumes:      -/path/to/media:/mediasonarr:volumes:      -/path/to/media:/media

To keep your media in sync, webhook urls are required in your integrations. Midarr accepts aPOST request from your integrations with your unique API Token (found on the Midarr Settings page).

Add these webhook urls to Radarr / Sonarr underSettings -> Connect -> Webhook:

http://midarr:4000/api/webhooks/movie?token=some-api-token

http://midarr:4000/api/webhooks/series?token=some-api-token

We support the following integration versions:

• Radarrv5.x
• Sonarrv4.x

Thank you for all your contributions! Big or small - all is welcome!

1. Fork and git clone the repository

git clone https://github.com/{ YOUR-ACCOUNT }/midarr-server.git

2. Docker compose up the stack

cd midarr-server && docker compose up -d

3. Service locations:

• http://localhost:4000 - Midarr
• http://localhost:7878 - Radarr
• http://localhost:8989 - Sonarr

Midarr is open-sourced software licensed under theMIT license.