diff --git a/images/docker-htpcmanager.md b/images/docker-htpcmanager.md index c7863c24bc..c4c2231cbe 100755 --- a/images/docker-htpcmanager.md +++ b/images/docker-htpcmanager.md @@ -1,94 +1,140 @@ -[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/Hellowlol/HTPC-Manager -[hub]: https://hub.docker.com/r/linuxserver/htpcmanager/ +# [linuxserver/htpcmanager](https://github.com/linuxserver/docker-htpcmanager) -[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) +[![](https://images.microbadger.com/badges/version/linuxserver/htpcmanager.svg)](https://microbadger.com/images/linuxserver/htpcmanager "Get your own version badge on microbadger.com") +[![](https://images.microbadger.com/badges/image/linuxserver/htpcmanager.svg)](https://microbadger.com/images/linuxserver/htpcmanager "Get your own version badge on microbadger.com") +![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/htpcmanager.svg) +![Docker Stars](https://img.shields.io/docker/stars/linuxserver/htpcmanager.svg) +[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-htpcmanager/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-htpcmanager/job/master/) +[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/htpcmanager/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/htpcmanager/latest/index.html) -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! +[Htpcmanager](https://url.com/) is a front end for many htpc related applications. Hellowlol version. -# linuxserver/htpcmanager -[![](https://images.microbadger.com/badges/version/linuxserver/htpcmanager.svg)](https://microbadger.com/images/linuxserver/htpcmanager "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/htpcmanager.svg)](https://microbadger.com/images/linuxserver/htpcmanager "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/htpcmanager.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/htpcmanager.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-htpcmanager)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-htpcmanager/) +## Supported Architectures -Htpcmanager, a front end for many htpc related applications. Hellowlol version.[Htpcmanager](https://github.com/Hellowlol/HTPC-Manager) +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). + +Simply pulling `linuxserver/htpcmanager` 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 | +| :----: | --- | +| x86-64 | amd64-latest | +| arm64 | arm64v8-latest | +| armhf | arm32v6-latest | -[![htpcmanager](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/htpcmanager-icon.png)][appurl] ## Usage +Here are some example snippets to help you get started creating a container from this image. + +### docker + ``` -docker create --name=htpcmanager \ --v :/config \ --e PGID= -e PUID= \ --e TZ= \ --p 8085:8085 \ -linuxserver/htpcmanager +docker create \ + --name=htpcmanager \ + -e PUID=1001 \ + -e PGID=1001 \ + -e TZ=Europe/London \ + -p 8085:8085 \ + -v :/config \ + --restart unless-stopped \ + linuxserver/htpcmanager +``` + + +### docker-compose + +Compatible with docker-compose v2 schemas. + +```yaml +--- +version: "2" +services: + htpcmanager: + image: linuxserver/htpcmanager + container_name: htpcmanager + environment: + - PUID=1001 + - PGID=1001 + - TZ=Europe/London + volumes: + - :/config + ports: + - 8085:8085 + mem_limit: 4096m + restart: unless-stopped ``` ## 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.` +Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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`) + +| Parameter | Function | +| :----: | --- | +| `8085` | Application WebUI | -* `-p 8085` - the port(s) -* `-v /config` - where htpcmanager should store its configuration files. -* `-e PGID` for GroupID - see below for explanation -* `-e PUID` for UserID - see below for explanation -* `-e TZ` for timezone information, eg Europe/London +### Environment Variables (`-e`) -It is based on alpine-linux with s6 overlay, for shell access whilst the container is running do `docker exec -it htpcmanager /bin/bash`. +| Env | Function | +| :----: | --- | +| `PUID=1001` | for UserID - see below for explanation | +| `PGID=1001` | for GroupID - see below for explanation | +| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. | + +### Volume Mappings (`-v`) + +| Volume | Function | +| :----: | --- | +| `/config` | Configuration files. | -### 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" ™. +## User / Group Identifiers -In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: +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=1001` and `PGID=1001`, to find yours use `id user` as below: ``` - $ id + $ id username uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) ``` -## Setting up the application +## Application Setup -The webui is found at port 8085. +The webui is found at port 8085. Smartmontools has not been included, you can safely ignore the warning error in the log. -Smartmontools has not been included, you can safely ignore the warning error in the log. -## Info - -* To monitor the logs of the container in realtime `docker logs -f htpcmanager`. - -* container version number - -`docker inspect -f '{{ index .Config.Labels "build_version" }}' htpcmanager` - -* image version number - -`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/manager` +## Support Info +* Shell access whilst the container is running: + * `docker exec -it htpcmanager /bin/bash` +* To monitor the logs of the container in realtime: + * `docker logs -f htpcmanager` +* Container version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' htpcmanager` +* Image version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/htpcmanager` ## Versions -+ **16.01.19:** Add pipeline logic and multi arch. -+ **17.08.18:** Rebase to alpine 3.8. -+ **12.12.17:** Rebase to alpine 3.7. -+ **20.07.17:** Internal git pull instead of at runtime. -+ **25.05.17:** Rebase to alpine 3.6. -+ **07.02.17:** Rebase to alpine 3.5. -+ **14.10.16:** Add version layer information. -+ **26.09.16:** Add back cherrypy after removal from baseimage. -+ **10.09.16:** Add layer badges to README. -+ **28.08.16:** Add badges to README. -+ **08.08.16:** Rebase to alpine linux. -+ **14.01.15:** Remove hardcoded loglevel from the run command, set in webui -+ **19.09.15:** Initial Release. +* **16.01.19:** - Add pipeline logic and multi arch. +* **17.08.18:** - Rebase to alpine 3.8. +* **12.12.17:** - Rebase to alpine 3.7. +* **20.07.17:** - Internal git pull instead of at runtime. +* **25.05.17:** - Rebase to alpine 3.6. +* **07.02.17:** - Rebase to alpine 3.5. +* **14.10.16:** - Add version layer information. +* **26.09.16:** - Add back cherrypy after removal from baseimage. +* **10.09.16:** - Add layer badges to README. +* **28.08.16:** - Add badges to README. +* **08.08.16:** - Rebase to alpine linux. +* **14.01.15:** - Remove hardcoded loglevel from the run command, set in webui +* **19.09.15:** - Initial Release.