Documentation / Docker

Docker

For Docker Engine on Linux. On a Mac or a Windows computer, use the installer.

1. Start it

The command

docker run -d --name magpie \
  --network host \
  -v magpie-data:/data \
  -v /srv/media:/media \
  ayerselectronics/magpie

--network host

The console answers on port 24622.

-v magpie-data:/data

Everything Magpie remembers: channels, people, settings, artwork. Never add this folder as a library.

-v /srv/media:/media

Your media. Replace /srv/media with the folder on this computer that holds your films and shows. Inside the container it is /media. The server runs as user 999, which needs to be able to read it. Add :ro to keep the container from writing there; leave it off if you will turn on filing downloads, copying discs, info files, music tags or Replace. Copying discs also needs the drive passed into the container: see Importing Discs.

2. Claim the server

Get the setup link

A new server prints a one-time link when it starts. It works for 10 minutes, so make a fresh one when you are ready:

docker exec magpie /app/Magpie.Server --reset-passcode

Restarting the container also prints one, which docker logs magpie shows.

Open it on this computer

Open the link in a browser on the computer running Docker, name your network, and set your passcode. The link is refused from any other device.

No screen on this computer

From another computer, forward the port over SSH first, then open the link there within 10 minutes:

ssh -L 24622:127.0.0.1:24622 you@your-server

Forgot the passcode

The same --reset-passcode command makes a link to set a new one.

3. Add your media

Add a library

In the console, open Library › Libraries and press Add Library. Choose what it holds and name it, then press Add Folder and type the path as the container sees it, such as /media/Movies for /srv/media/Movies on this computer. A folder that does not exist, or Magpie's own /data, is refused.

Then

Press Scan Everything, and see Getting Started for your first channel.

Updating

Pull, remove, start again

docker pull ayerselectronics/magpie
docker rm -f magpie
docker run -d --name magpie \
  --network host \
  -v magpie-data:/data \
  -v /srv/media:/media \
  ayerselectronics/magpie

A host folder for state

To keep state in a folder instead of the volume (-v /srv/magpie:/data), give it to user 999 first: sudo chown -R 999 /srv/magpie.

Getting help

Docker Hub

hub.docker.com/r/ayerselectronics/magpie — tags and image details.

Installing

Installing covers the native installers, if Docker isn't what you want.

Already use Plex or Jellyfin

Other Players covers adding Magpie's channels to the player you already use.

Something wrong

Report an issue.