install.md

Install mStream Velvet (bare-metal)

Prefer Docker? See docker.md for the recommended container-based setup.

Dependencies

• Node.js v22 or greater (nodejs.org)
• npm
• git

Install

git clone https://github.com/aroundmyroom/mStream.git
cd mStream
npm install --only=prod
node cli-boot-wrapper.js

Open http://localhost:3000 — on a fresh install with no users the admin panel is accessible without login.

---

Running as a systemd service (Linux)

Create /etc/systemd/system/music.service:

[Unit]
Description=mStream Velvet
After=network.target

[Service]
Type=simple
User=YOUR_USER
WorkingDirectory=/path/to/mStream
ExecStart=/usr/bin/node cli-boot-wrapper.js
Restart=on-failure

[Install]
WantedBy=multi-user.target

systemctl daemon-reload
systemctl enable music.service
systemctl start music.service

---

Running as a background process with PM2

npm install -g pm2
pm2 start cli-boot-wrapper.js --name mStream
pm2 save
pm2 startup

PM2 quick-start docs

---

Updating

git pull
npm install --only=prod
systemctl restart music.service   # or: pm2 restart all