docker-documentation/images/docker-muximux.md

141 wiersze
5.4 KiB
Markdown
Czysty Zwykły widok Historia

2019-04-01 11:50:51 +00:00
# [linuxserver/muximux](https://github.com/linuxserver/docker-muximux)
2019-02-11 12:51:31 +00:00
2019-09-02 11:51:43 +00:00
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-muximux.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-muximux/releases)
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/muximux.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/muximux "Get your own version badge on microbadger.com")
[![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/muximux.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/muximux "Get your own version badge on microbadger.com")
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/muximux.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/muximux)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/muximux.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/muximux)
[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-muximux/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-muximux/job/master/)
2019-04-01 11:50:51 +00:00
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/muximux/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/muximux/latest/index.html)
2019-02-11 12:51:31 +00:00
2019-02-12 14:47:51 +00:00
[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.
2019-02-11 12:51:31 +00:00
2019-02-12 14:47:51 +00:00
## Supported Architectures
2019-02-11 12:51:31 +00:00
2019-09-02 11:51:43 +00:00
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/).
2019-02-12 14:47:51 +00:00
Simply pulling `linuxserver/muximux` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
| Architecture | Tag |
2019-04-01 11:50:51 +00:00
| :----: | --- |
2019-02-12 14:47:51 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 21:06:32 +00:00
| armhf | arm32v7-latest |
2019-02-11 12:51:31 +00:00
2019-04-01 11:50:51 +00:00
2019-02-11 12:51:31 +00:00
## Usage
2019-02-12 14:47:51 +00:00
Here are some example snippets to help you get started creating a container from this image.
### docker
2019-04-01 11:50:51 +00:00
```
2019-02-11 12:51:31 +00:00
docker create \
--name=muximux \
2019-03-04 12:50:50 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-12 14:47:51 +00:00
-e TZ=Europe/London \
-p 80:80 \
2019-02-11 12:51:31 +00:00
-v <path to data>:/config \
2019-02-12 14:47:51 +00:00
--restart unless-stopped \
2019-02-11 12:51:31 +00:00
linuxserver/muximux
```
2019-04-01 11:50:51 +00:00
2019-02-12 14:47:51 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
muximux:
image: linuxserver/muximux
container_name: muximux
environment:
2019-03-04 12:50:50 +00:00
- PUID=1000
- PGID=1000
2019-02-12 14:47:51 +00:00
- TZ=Europe/London
volumes:
- <path to data>:/config
ports:
- 80:80
restart: unless-stopped
```
2019-02-11 12:51:31 +00:00
## Parameters
2019-04-01 11:50:51 +00:00
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.
2019-02-12 14:47:51 +00:00
2019-04-01 11:50:51 +00:00
### Ports (`-p`)
2019-02-11 12:51:31 +00:00
2019-02-12 14:47:51 +00:00
| Parameter | Function |
2019-04-01 11:50:51 +00:00
| :----: | --- |
2019-02-12 14:47:51 +00:00
| `80` | WebUI |
2019-02-11 12:51:31 +00:00
2019-04-01 11:50:51 +00:00
### Environment Variables (`-e`)
2019-02-11 12:51:31 +00:00
2019-02-12 14:47:51 +00:00
| Env | Function |
2019-04-01 11:50:51 +00:00
| :----: | --- |
2019-03-04 12:50:50 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-12 14:47:51 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
2019-02-11 12:51:31 +00:00
2019-04-01 11:50:51 +00:00
### Volume Mappings (`-v`)
2019-02-11 12:51:31 +00:00
2019-02-12 14:47:51 +00:00
| Volume | Function |
2019-04-01 11:50:51 +00:00
| :----: | --- |
2019-02-12 14:47:51 +00:00
| `/config` | Where muximux should store its files. |
2019-04-01 11:50:51 +00:00
2019-02-12 14:47:51 +00:00
## User / Group Identifiers
2019-04-01 11:50:51 +00:00
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`.
2019-02-12 14:47:51 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-04 12:50:50 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
2019-02-11 12:51:31 +00:00
2019-04-01 11:50:51 +00:00
```
2019-02-12 14:47:51 +00:00
$ id username
2019-03-04 12:50:50 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-11 12:51:31 +00:00
```
2019-02-12 14:47:51 +00:00
## Application Setup
2019-02-11 12:51:31 +00:00
2019-04-01 11:50:51 +00:00
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)
2019-02-11 12:51:31 +00:00
2019-02-12 14:47:51 +00:00
## Support Info
2019-02-11 12:51:31 +00:00
2019-09-02 11:51:43 +00:00
* Shell access whilst the container is running:
2019-02-12 14:47:51 +00:00
* `docker exec -it muximux /bin/bash`
2019-09-02 11:51:43 +00:00
* To monitor the logs of the container in realtime:
2019-02-12 14:47:51 +00:00
* `docker logs -f muximux`
2019-09-02 11:51:43 +00:00
* Container version number
2019-02-12 14:47:51 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' muximux`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/muximux`
2019-02-11 12:51:31 +00:00
## Versions
2019-07-02 15:42:51 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-03-24 21:06:32 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-27 18:05:30 +00:00
* **22.02.19:** - Rebasing to alpine 3.9.
2019-02-12 14:47:51 +00:00
* **16.01.19:** - Add pipeline logic and multi arch.
* **13.09.18:** - Rebase to alpine 3.8.
* **09.01.18:** - Rebase to alpine 3.7.
* **25.05.17:** - Rebase to alpine 3.6.
* **12.02.17:** - Rebase to alpine 3.5.
* **14.10.16:** - Add version layer information.
* **30.09.16:** - Rebase to alpine linux.
* **09.09.16:** - Add badges to README.
* **22.02.16:** - Initial release date.