​​​ ​​ ​​ ​​ ​​ ​​ ​​ ​​ ​​​

​mstream is a personal music streaming server. You can use mStream to stream your music from your home computer to any device, anywhere. There are mobile apps available for both Android and iPhone.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling ghcr.io/linuxserver/mstream should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Application Setup

Access the webui at http://<your-ip>:3000, For most users specifying a $USER and $PASSWORD is sufficient, the USE_JSON option allows for more granular control of mStream, but with added complexity, requiring manual editing of config.json to configure your install, for more information check out Mstream. Note using this option will make the default username:password admin and password respectively and any environmental variables will be ignored.

Usage

Here are some example snippets to help you get started creating a container from this image.

docker-compose (recommended)

Compatible with docker-compose v2 schemas.

---
version: "2.1"
services:
  mstream:
    image: ghcr.io/linuxserver/mstream
    container_name: mstream
    environment:
      - PUID=1000
      - PGID=1000
      - USER=admin
      - PASSWORD=password
      - USE_JSON=true/false
      - TZ=Europe/London
    volumes:
      - <path to data>:/config
      - <path to music>:/music
    ports:
      - 3000:3000
    restart: unless-stopped

docker cli

docker run -d \
  --name=mstream \
  -e PUID=1000 \
  -e PGID=1000 \
  -e USER=admin \
  -e PASSWORD=password \
  -e USE_JSON=true/false \
  -e TZ=Europe/London \
  -p 3000:3000 \
  -v <path to data>:/config \
  -v <path to music>:/music \
  --restart unless-stopped \
  ghcr.io/linuxserver/mstream

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Environment Variables (-e)

Volume Mappings (-v)

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Docker Mods

​​​ ​​​

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

• Shell access whilst the container is running:

  • docker exec -it mstream /bin/bash

• To monitor the logs of the container in realtime:

  • docker logs -f mstream

• Container version number

  • docker inspect -f '{{ index .Config.Labels "build_version" }}' mstream

• Image version number

  • docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/mstream

Versions

• 23.01.21: - Rebasing to alpine 3.13.

• 01.06.20: - Rebasing to alpine 3.12.

• 19.12.19: - Rebasing to alpine 3.11.

• 28.06.19: - Rebasing to alpine 3.10.

• 18.05.19: - Inital Release