linuxserver/mstream

[!TIP]

前半部分是翻译官方的文档,最后一部分是我的简单试用(个别软件会深度试用),如果对Docker已经有一定的了解了,可以直接跳转到最后面 翻译之外 这部分来查看。

mStream → https://mstream.io/

GitHub → https://github.com/linuxserver/docker-mstream

Docker Hub → https://hub.docker.com/r/linuxserver/mstream

mStream 是个人音乐流服务器。您可以使用mStream将音乐从家用计算机流式传输到任何地方的任何设备。有适用于Android和iPhone的移动应用程序。


支持的系统架构

得益于docker的跨平台属性,我们的镜像也支持多架构(如,x86-64、arm64、armhf)。

直接拉取 ghcr.io/linuxserver/mstream 应该就可以自动获取适合你系统架构的版本,当然你也可以通过 tag 获取特定的版本。

架构 Tag
x86-64 amd64-latest
arm64 arm64v8-latest
armhf arm32v7-latest

拉取镜像

  1. docker pull ghcr.io/linuxserver/mstream

使用方法

以下是一些简单的示例。

docker-compose

兼容docker-compose v2

  1. ---
  2. version: "2.1"
  3. services:
  4. mstream:
  5. image: ghcr.io/linuxserver/mstream
  6. container_name: mstream
  7. environment:
  8. - PUID=1000
  9. - PGID=1000
  10. - USER=admin
  11. - PASSWORD=password
  12. - USE_JSON=true/false
  13. - TZ=Europe/London
  14. volumes:
  15. - <path to data>:/config
  16. - <path to music>:/music
  17. ports:
  18. - 3000:3000
  19. restart: unless-stopped

docker cli

  1. docker run -d \
  2. --name=mstream \
  3. -e PUID=1000 \
  4. -e PGID=1000 \
  5. -e USER=admin \
  6. -e PASSWORD=password \
  7. -e USE_JSON=true/false \
  8. -e TZ=Europe/London \
  9. -p 3000:3000 \
  10. -v <path to data>:/config \
  11. -v <path to music>:/music \
  12. --restart unless-stopped \
  13. ghcr.io/linuxserver/mstream

参数

Docker镜像在使用的时候需要配置一些参数,这些参数使用 : 分隔,分别表示 宿主机:容器内。例如 -p 8080:80 指的是将容器内的80端口映射到宿主机上的8080端口,即通过宿主机网络访问的话,访问8080端口即是访问容器内的80端口。

端口(-p

port 说明
3000 WebUI访问端口

环境变量(-e

env 说明
PUID=1000 用户的 UID,详见下面的说明
PGID=1000 用户的 GID,详见下面的说明
TZ=Europe/London 设置时区,在国内的话可以使用 Asia/Shanghai
USER=admin 设置登陆的用户名
PASSWORD=password 设置用户的密码
USE_JSON=true/false 使用/config/config.json中指定的配置运行mStream,请注意,这将意味着在config.json中定义了用户/密码

卷映射(-v

volume 说明
/config 配置文件所在路径
/music 音乐文件夹

从文件加载环境变量

可以使用前缀名为 FILE__ 的文件来加载环境变量。

例:

  1. -e FILE__PASSWORD=/run/secrets/mysecretpassword

将把 /run/secrets/mysecretpassword 文件中的内容作为 PASSWORD 变量的值。


运行程序的umask(文件掩码)

我们所有的镜像都可以使用 -e UMASK=022 来设置覆盖容器内服务的umask。关于Linux umask可以通过这里了解,或自行百度学习。


UID和GID

当使用 -v 映射卷的时候,宿主机和容器内会出现关于权限的问题,我们的镜像可以通过指定 PUIDGUID 来避免此类问题。

可以使用你目前正在使用的用户的UID和GID进行设置,这样就不会存在权限问题。

可以通过如下的方式查看当前用户的UID和GID:

  1. $ id $user
  2. uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

[!NOTE]

如果没特殊需求,可以将后续所有容器的id都设置为当前非root用户的id,这样会省去解决很多关于文件权限的问题(可以查看 什么是PUID和PGID 这篇文章了解更多)。当然,如果有特殊需要可以给不同的容器设置不同的id,即分配给不同的用户。使用 useradd 命令即可添加用户。通常来说,除root账户外,第一个建立的用户的UID和GID都是1000,然后递增生成。


安装说明

Web界面:http://ip:3000

对于大多数用户,指定 $USER$PASSWORD 就足够了,USE_JSON 选项允许对 mStream 进行更精细的控制,但是增加了复杂性,需要手动编辑 config.json 来配置安装,有关更多信息,请参阅 Mstream。请注意,使用此选项将分别使用默认的用户名/密码 admin/password,所有环境变量都将被忽略。


支持

  • 进入容器:
    • docker exec -it mstream /bin/bash
  • 查看容器日志:
    • docker logs -f mstream
  • 查看容器版本号:
    • docker inspect -f '{% raw %}{{% endraw %}{ index .Config.Labels "build_version" }}' mstream
  • 查看镜像版本号:
    • docker inspect -f '{% raw %}{{% endraw %}{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/mstream

翻译之外

暂未试用