How to Install mStream on Your Synology NAS

by

How to Install mStream on Your Synology NAS

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. In this step by step guide I will show you how to install mStream on your Synology NAS using Docker.

šŸ’”Note: This guide works perfectly with the latest mStream v5.13.1Ā release.

  • STEP 1

Please Support My work by Making a Donation.

  • STEP 2

Install Container Manager via Synology ā€œPackage Centerā€. If you run an older DSM version (under 7.2), search for Docker instead of Container Manager.

Download Container Manager Synology Docker

  • STEP 3

Go toĀ File StationĀ and open the docker folder. Inside the docker folder, create one new folder and name itĀ mstream. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

mStream Synology NAS Set up 1

  • STEP 4

Go toĀ Control PanelĀ /Ā Task SchedulerĀ /Ā CreateĀ /Ā Scheduled TaskĀ /Ā User-defined script. Follow the instructions in the image below.

Synology User Defined Script

  • STEP 5

Once you click on User-defined script a new window will open. Follow the instructions below:

  1. General: In the Task field type in ā€œInstall mStreamā€œ. Uncheck ā€œEnabledā€ option. SelectĀ rootĀ User.
  2. Schedule: SelectĀ Run on the following dateĀ then select ā€œDo not repeatā€œ.
  3. Task Settings: Check ā€œSend run details by emailā€œ, add your email then copy paste the code below in the Run command area. After that clickĀ OK.
docker run -d --name=mstream \
-p 3578:3000 \
-e PUID=1026 \
-e PGID=100 \
-e TZ=Europe/Bucharest \
-v /volume1/docker/mstream:/config \
-v /volume1/web/music:/music \
--restart always \
ghcr.io/linuxserver/mstream

Note: Before you paste the code above in the Run command area, change the value numbers for PUIDĀ andĀ PGIDĀ with your own values. (Follow my step by step guide on how to do this.)
Note: Before you paste the code above in the Run command area, change the value for TZĀ (Select your current Time Zone from this list).
Note: in the code above afterĀ -v /volume1/docker/mstream:/config \ you have to add your personal path to music. For example I have used my personal music path folder -v /volume1/web/music:/music \ Change it according to your preferences.Ā -v /path/toyour/music:/musicĀ  \

mStream Synology NAS Set up 3 new 2023

  • STEP 6

After you click OK on STEP 5 a new warning pop up window will open. Click OK.

mStream Synology NAS Set up 4

After you click OK, type in your DSM Password then click Submit. Follow the instructions in the image below.

Synology Task Scheduler Confirm Admin Password

  • STEP 7

After you click Submit on STEP 6, select your ā€œInstall mStreamā€ Task then click the ā€œRunā€ tab. You will be asked to run Install mStream ā€“ click OK. Follow the instructions in the image below.

mStream Synology NAS Set up 5

  • STEP 8

šŸŸ¢Please Support My work by Making a Donation. Almost 99,9% of the people that install something using my guidesĀ forget to support my work, or justĀ ignoreĀ STEP 1. Iā€™ve been very honest about this aspect of my work since the beginning: I donā€™t run any ADS, I donā€™t require subscriptions, paid or otherwise, I donā€™t collect IPs, emails, and I donā€™t have any referral links from Amazon or other merchants. I also donā€™t have any POP-UPs or COOKIES. I have repeatedly been told over the years how much I have contributed to the community. Itā€™s something I love doing and have been honest about my passion since the beginning. But I also Need The Community to Support me Back to be able to continue doing this work.

  • STEP 9

The installation process can take up to a few seconds/minutes. It will depend on your Internet speed connection. Now open your browser and type inĀ http://Synology-ip-address:3578

mStream Synology NAS Set up 6

Note: If you want to run mStream container over HTTPS check How to Run Docker Containers Over HTTPS.

Note: If you experience permissions problems, just right mouse click on your folder where you have your music files stored. Click on Property,Ā PermissionĀ tab,Ā CreateĀ tab,Ā user & groupĀ search forĀ SYSTEMĀ then addĀ read / writeĀ toĀ SYSTEMĀ and clickĀ Done. Check Apply to this folder, sub-folders and files then clickĀ Save. Now try again: open your browser and type inĀ http://Synology-ip-address:3578
Note: Can I run Docker on my Synology NAS?Ā See the supported models.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Find outĀ how to update mStream container with the latest image.
Note: Instead of mStream you can try Synology Audio Station.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: How to Schedule Start & Stop For Docker Containers.
Note: How to Activate Email Notifications.
Note: How to Add Access Control Profile on Your NAS.
Note: How to Change Docker Containers Restart Policy.
Note: How to Use Docker Containers With VPN.
Note: Convert Docker Run Into Docker Compose.
Note: How to Clean Docker.
Note: How to Clean Docker Automatically.
Note: Best Practices When Using Docker and DDNS.
Note: Some Docker Containers Need WebSocket.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Containers.

This post was updated on Thursday / January 9th, 2025 at 8:06 PM

šŸ§” I Need Your Help!