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.
Simply pulling
lscr.io/linuxserver/mstream:latest 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 | Available | Tag |
|---|---|---|
x86-64 | ✅ | amd64-<version tag> |
arm64 | ✅ | arm64v8-<version tag> |
armhf | ✅ | arm32v7-<version tag> |
Access the webui at
http://<your-ip>:3000Settings are adjusted through the web ui or via editing of
config.json. For more information check out Mstream.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.To help you get started creating a container from this image you can either use docker-compose or the docker cli.
---
version: "2.1"
services:
mstream:
image: lscr.io/linuxserver/mstream:latest
container_name: mstream
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
volumes:
- /path/to/data:/config
- /path/to/music:/music
ports:
- 3000:3000
restart: unless-stopped
docker run -d \
--name=mstream \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-p 3000:3000 \
-v /path/to/data:/config \
-v /path/to/music:/music \
--restart unless-stopped \
lscr.io/linuxserver/mstream:latest
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.Parameter | Function |
|---|---|
3000 | The port for the mStream webinterface |
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 | Function |
|---|---|
/config | mStream config |
/music | Music location |
Miscellaneous Options
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.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.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)
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.
- 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:latest
- 05.04.22: - Move
syncfolder to/config. - 02.04.22: - Rebase to alpine 3.15. Fix ffmpeg download.
- 17.05.21: - Deprecating the env vars
USER,PASSWORDandUSE_JSONas mStream v5 requires the use ofconfig.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
Last modified 6mo ago