linuxserver/mstream

​​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​​
​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 lscr.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:
Architecture
Tag
x86-64
amd64-latest
arm64
arm64v8-latest
armhf
arm32v7-latest
Application Setup
Access the webui at http://<your-ip>:3000
Settings are adjusted through the web ui or via editing of config.json. For more information check out Mstream.
IMPORTANT NOTICE:
mStream v5 no longer accepts cli arguments for setting the user and password and requires the use of config.json. Therefore, the environment variables USER, PASSWORD and USE_JSON are deprecated.
v4's config.json is not compatible with v5. Existing config.json will be renamed to config.json.v4-bak for your reference and a new default config.json will be created upon upgrade from v4 to v5.
Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)
1
---
2
version: "2.1"
3
services:
4
  mstream:
5
    image: lscr.io/linuxserver/mstream
6
    container_name: mstream
7
    environment:
8
      - PUID=1000
9
      - PGID=1000
10
      - TZ=Europe/London
11
    volumes:
12
      - /path/to/data:/config
13
      - /path/to/music:/music
14
    ports:
15
      - 3000:3000
16
    restart: unless-stopped
Copied!
docker cli (click here for more info)
1
docker run -d \
2
  --name=mstream \
3
  -e PUID=1000 \
4
  -e PGID=1000 \
5
  -e TZ=Europe/London \
6
  -p 3000:3000 \
7
  -v /path/to/data:/config \
8
  -v /path/to/music:/music \
9
  --restart unless-stopped \
10
  lscr.io/linuxserver/mstream
Copied!
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)
Parameter
Function
3000
The port for the mStream webinterface
Environment Variables (-e)
Env
Function
PUID=1000
for UserID - see below for explanation
PGID=1000
for GroupID - see below for explanation
TZ=Europe/London
Specify a timezone to use e.g. Europe/London
Volume Mappings (-v)
Volume
Function
/config
mStream config
/music
Music location
Miscellaneous Options
Parameter
Function
Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
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:
1
  $ id username
2
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!
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" }}' lscr.io/linuxserver/mstream
Versions
17.05.21: - Deprecating the env vars USER, PASSWORD and USE_JSON as mStream v5 requires the use of config.json.
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