Self-host mStream with Levelrail

A lightweight personal music streaming server with a web player and mobile apps.

  • AuthorIrosTheBeggar
  • LicenceGPL-3.0-only
  • Memory256 MiB
  • Services1

How to self-host mStream

  1. Pull the images

    One image is pulled on your server.

    Show images
    • lscr.io/linuxserver/mstream:6.33.1
  2. Create the app

    One service starts in a single Compose app, with 2 named volume mounts for your data, on port 3000.

  3. Fill in the secrets

    3 settings are preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

After the first start

  • Create the admin account on first visit, then upload music into the music volume.

mStream requirements

Memory
About 256 MiB
Architectures
amd64 unknown, arm64 unknown
Ports
3000
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
GPL-3.0-only, copyleft license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then mStream. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the mStream docs page.

Deploy mStream your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy mStream from the CLI

Add --domain SERVICE=HOST to serve a service on your own domain, for example --domain mstream=app.example.com.

levelrail-cli templates install mstream --name my-mstream

Deploy mStream with the API

Create a token in the dashboard first. Name, env and domains are the request fields.

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  https://levelrail.example.com/api/v1/service-templates/mstream/install \
  -d '{
    "name": "my-mstream"
  }'

mStream configuration

mStream services

ServiceImagePortsVolumes
mstream lscr.io/linuxserver/mstream:6.33.1 3000 config -> /configmusic -> /music

mStream environment variables

VariableServiceValue
PGID mstream Preset by the template
PUID mstream Preset by the template
TZ mstream Preset by the template

Ports and volumes

Ports
3000
Volumes
2 named mounts: config -> /config, music -> /music

mStream FAQ

How much memory does mStream need?

The catalog lists about 256 MiB of memory for mStream.

Does mStream run on arm64?

For mStream, arm64 support is not confirmed; amd64 is unknown.

What licence is mStream under?

mStream is licensed under GPL-3.0-only, which is copyleft, so changes you distribute must be shared under the same terms.

Does mStream need configuration before it starts?

No. The template fills in its own defaults.

Which ports does mStream use?

mStream listens on port 3000 inside the stack.

Where does mStream keep its data?

In named volumes: config mounted at /config and music mounted at /music.

Can I deploy mStream on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for mStream, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image lscr.io/linuxserver/mstream:6.33.1 is what you deploy there.

levelrail-cli templates install mstream --name my-mstream