diff --git a/images/docker-muximux.md b/images/docker-muximux.md new file mode 100755 index 000000000..ad791482f --- /dev/null +++ b/images/docker-muximux.md @@ -0,0 +1,89 @@ +[linuxserverurl]: https://linuxserver.io +[forumurl]: https://forum.linuxserver.io +[ircurl]: https://www.linuxserver.io/irc/ +[podcasturl]: https://www.linuxserver.io/podcast/ +[appurl]: https://github.com/mescon/Muximux +[hub]: https://hub.docker.com/r/linuxserver/muximux/ + +[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] + +The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: +* [forum.linuxserver.io][forumurl] +* [IRC][ircurl] on freenode at `#linuxserver.io` +* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! + +# linuxserver/muximux +[![](https://images.microbadger.com/badges/version/linuxserver/muximux.svg)](https://microbadger.com/images/linuxserver/muximux "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/muximux.svg)](https://microbadger.com/images/linuxserver/muximux "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/muximux.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/muximux.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-muximux)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-muximux/) + +This 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. [Muximux][appurl]. + +[![muximux](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/muximux-icon.png)][appurl] + +## Usage + +``` +docker create \ + --name=muximux \ + -v :/config \ + -e PGID= -e PUID= \ + -e TZ= -p 80:80 \ + linuxserver/muximux +``` + +## Parameters + +`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. +For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. +So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 +http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.` + + +* `-p 80` - the port(s) +* `-v /config` - Where muximux should store its files +* `-e PGID` for GroupID - see below for explanation +* `-e PUID` for UserID - see below for explanation +* `-e TZ` for timezone setting, eg Europe/London + +It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it muximux /bin/bash`. + +### User / Group Identifiers + +Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™. + +In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: + +``` + $ id + uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) +``` + +## Setting up the application + +Find the web interface at `:80` , set apps you wish to use with muximux via the webui. +More info:- [Muximux][appurl] + + +## Info + +* Shell access whilst the container is running: `docker exec -it muximux /bin/bash` +* To monitor the logs of the container in realtime: `docker logs -f muximux` + +* container version number + +`docker inspect -f '{{ index .Config.Labels "build_version" }}' muximux` + +* image version number + +`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/muximux` + +## Versions + ++ **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.