kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
091c821bf6
commit
9f070c9ca3
|
|
@ -1,9 +1,18 @@
|
|||
# linuxserver/mstream
|
||||
# [linuxserver/mstream](https://github.com/linuxserver/docker-mstream)
|
||||
|
||||
[](https://github.com/linuxserver/docker-mstream) [](https://github.com/linuxserver/docker-mstream/releases) [](https://github.com/linuxserver/docker-mstream/packages) [](https://gitlab.com/Linuxserver.io/docker-mstream/container_registry) [](https://microbadger.com/images/linuxserver/mstream) [](https://hub.docker.com/r/linuxserver/mstream) [](https://hub.docker.com/r/linuxserver/mstream) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-mstream/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/mstream/latest/index.html)
|
||||
[](https://github.com/linuxserver/docker-mstream)
|
||||
[](https://github.com/linuxserver/docker-mstream/releases)
|
||||
[](https://github.com/linuxserver/docker-mstream/packages)
|
||||
[](https://gitlab.com/Linuxserver.io/docker-mstream/container_registry)
|
||||
[](https://microbadger.com/images/linuxserver/mstream "Get your own version badge on microbadger.com")
|
||||
[](https://hub.docker.com/r/linuxserver/mstream)
|
||||
[](https://hub.docker.com/r/linuxserver/mstream)
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-mstream/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/mstream/latest/index.html)
|
||||
|
||||
[mstream](https://mstream.io/) 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.
|
||||
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
||||
|
|
@ -13,18 +22,19 @@ Simply pulling `linuxserver/mstream` should retrieve the correct image for your
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v7-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```text
|
||||
```
|
||||
docker create \
|
||||
--name=mstream \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -40,6 +50,7 @@ docker create \
|
|||
linuxserver/mstream
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -68,18 +79,19 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Ports \(`-p`\)
|
||||
### Ports (`-p`)
|
||||
|
||||
| Parameter | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `3000` | The port for the mStream webinterface |
|
||||
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
|
||||
| Env | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `USER=admin` | Set username to login |
|
||||
|
|
@ -87,20 +99,22 @@ Docker images are configured using parameters passed at runtime \(such as those
|
|||
| `USE_JSON=true/false` | Run mStream using the config specified at `/config/config.json`, note this will mean user/password is defined in `config.json` |
|
||||
| `TZ=Europe/London` | Specify a timezone to use e.g. Europe/London |
|
||||
|
||||
### Volume Mappings \(`-v`\)
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `/config` | mStream config |
|
||||
| `/music` | Music location |
|
||||
|
||||
## Environment variables from files \(Docker secrets\)
|
||||
|
||||
|
||||
## Environment variables from files (Docker secrets)
|
||||
|
||||
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||||
|
||||
As an example:
|
||||
|
||||
```text
|
||||
```
|
||||
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
||||
```
|
||||
|
||||
|
|
@ -108,17 +122,19 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
|
|||
|
||||
## Umask for running applications
|
||||
|
||||
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](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
||||
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](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
||||
|
||||
|
||||
## User / Group Identifiers
|
||||
|
||||
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`.
|
||||
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:
|
||||
|
||||
```text
|
||||
```
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
|
@ -127,11 +143,12 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
|
|||
|
||||
Access the webui at `http://<your-ip>:3000`, For most users specifying a `$USER` and `$PASSWORD` is sufficient, the `USE_JSON` option allows for more granular control of mStream, but with added complexity, requiring manual editing of `config.json` to configure your install, for more information check out [Mstream](https://github.com/IrosTheBeggar/mStream/blob/master/docs/json_config.md#json-config). Note using this option will make the default username:password `admin` and `password` respectively and any environmental variables will be ignored.
|
||||
|
||||
|
||||
## Docker Mods
|
||||
[](https://mods.linuxserver.io/?mod=mstream "view available mods for this container.")
|
||||
|
||||
[](https://mods.linuxserver.io/?mod=mstream)
|
||||
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.
|
||||
|
||||
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image \(if any\) can be accessed via the dynamic badge above.
|
||||
|
||||
## Support Info
|
||||
|
||||
|
|
@ -150,4 +167,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
|||
* **19.12.19:** - Rebasing to alpine 3.11.
|
||||
* **28.06.19:** - Rebasing to alpine 3.10.
|
||||
* **18.05.19:** - Inital Release
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue