kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
18e2320c41
commit
75612b94f5
|
|
@ -1,6 +1,14 @@
|
|||
# linuxserver/muximux
|
||||
# [linuxserver/muximux](https://github.com/linuxserver/docker-muximux)
|
||||
|
||||
[](https://github.com/linuxserver/docker-muximux) [](https://github.com/linuxserver/docker-muximux/releases) [](https://github.com/linuxserver/docker-muximux/packages) [](https://gitlab.com/Linuxserver.io/docker-muximux/container_registry) [](https://microbadger.com/images/linuxserver/muximux) [](https://hub.docker.com/r/linuxserver/muximux) [](https://hub.docker.com/r/linuxserver/muximux) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-muximux/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/muximux/latest/index.html)
|
||||
[](https://github.com/linuxserver/docker-muximux)
|
||||
[](https://github.com/linuxserver/docker-muximux/releases)
|
||||
[](https://github.com/linuxserver/docker-muximux/packages)
|
||||
[](https://gitlab.com/Linuxserver.io/docker-muximux/container_registry)
|
||||
[](https://microbadger.com/images/linuxserver/muximux "Get your own version badge on microbadger.com")
|
||||
[](https://hub.docker.com/r/linuxserver/muximux)
|
||||
[](https://hub.docker.com/r/linuxserver/muximux)
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-muximux/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/muximux/latest/index.html)
|
||||
|
||||
[Muximux](https://github.com/mescon/Muximux) is a lightweight portal to view & manage your HTPC apps without having to run anything more than a PHP enabled webserver. With Muximux you don't need to keep multiple tabs open, or bookmark the URL to all of your apps.
|
||||
|
||||
|
|
@ -13,18 +21,19 @@ Simply pulling `linuxserver/muximux` 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=muximux \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -36,6 +45,7 @@ docker create \
|
|||
linuxserver/muximux
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -60,35 +70,38 @@ 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 |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `80` | WebUI |
|
||||
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
|
||||
| Env | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
|
||||
### Volume Mappings \(`-v`\)
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `/config` | Where muximux should store its files. |
|
||||
|
||||
## 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
|
||||
```
|
||||
|
||||
|
|
@ -96,30 +109,34 @@ 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)
|
||||
```
|
||||
|
||||
## Application Setup
|
||||
|
||||
Find the web interface at `<your-ip>:80` , set apps you wish to use with muximux via the webui. More info:- [Muximux](https://github.com/mescon/Muximux)
|
||||
Find the web interface at `<your-ip>:80` , set apps you wish to use with muximux via the webui.
|
||||
More info:- [Muximux](https://github.com/mescon/Muximux)
|
||||
|
||||
|
||||
## Docker Mods
|
||||
[](https://mods.linuxserver.io/?mod=muximux "view available mods for this container.")
|
||||
|
||||
[](https://mods.linuxserver.io/?mod=muximux)
|
||||
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
|
||||
|
||||
|
|
@ -148,4 +165,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
|||
* **30.09.16:** - Rebase to alpine linux.
|
||||
* **09.09.16:** - Add badges to README.
|
||||
* **22.02.16:** - Initial release date.
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue