mirror of
https://github.com/linuxserver/docker-htpcmanager.git
synced 2026-04-06 00:01:54 +08:00
j0nnymoe
GitHub
commit
88abce66b5
193
README.md
193
README.md
@ -1,94 +1,167 @@
|
||||
[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/
|
||||
[](https://linuxserver.io)
|
||||
|
||||
[][linuxserverurl]
|
||||
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :-
|
||||
|
||||
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!
|
||||
* regular and timely application updates
|
||||
* easy user mappings (PGID, PUID)
|
||||
* custom base image with s6 overlay
|
||||
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
|
||||
* regular security updates
|
||||
|
||||
# linuxserver/htpcmanager
|
||||
[](https://microbadger.com/images/linuxserver/htpcmanager "Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/htpcmanager "Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-htpcmanager/)
|
||||
Find us at:
|
||||
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
|
||||
* [IRC](https://irc.linuxserver.io) - on freenode at `#linuxserver.io`. Our primary support channel is Discord.
|
||||
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
|
||||
* [Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018).
|
||||
|
||||
Htpcmanager, a front end for many htpc related applications. Hellowlol version.[Htpcmanager](https://github.com/Hellowlol/HTPC-Manager)
|
||||
# PSA: Changes are happening
|
||||
|
||||
From August 2018 onwards, Linuxserver are in the midst of switching to a new CI platform which will enable us to build and release multiple architectures under a single repo. To this end, existing images for `arm64` and `armhf` builds are being deprecated. They are replaced by a manifest file in each container which automatically pulls the correct image for your architecture. You'll also be able to pull based on a specific architecture tag.
|
||||
|
||||
TLDR: Multi-arch support is changing from multiple repos to one repo per container image.
|
||||
|
||||
# [linuxserver/htpcmanager](https://github.com/linuxserver/docker-htpcmanager)
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/htpcmanager "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/htpcmanager "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-htpcmanager/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/htpcmanager/latest/index.html)
|
||||
|
||||
[Htpcmanager](https://url.com/) is a front end for many htpc related applications. Hellowlol version.
|
||||
|
||||
[](https://url.com/)
|
||||
|
||||
## 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).
|
||||
|
||||
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 |
|
||||
|
||||
[][appurl]
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
docker create --name=htpcmanager \
|
||||
-v <path to data>:/config \
|
||||
-e PGID=<gid> -e PUID=<uid> \
|
||||
-e TZ=<timezone> \
|
||||
-p 8085:8085 \
|
||||
linuxserver/htpcmanager
|
||||
docker create \
|
||||
--name=htpcmanager \
|
||||
-e PUID=1001 \
|
||||
-e PGID=1001 \
|
||||
-e TZ=Europe/London \
|
||||
-p 8085:8085 \
|
||||
-v </path/to/appdata/config>:/config \
|
||||
--restart unless-stopped \
|
||||
linuxserver/htpcmanager
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
||||
```
|
||||
---
|
||||
version: "2"
|
||||
services:
|
||||
htpcmanager:
|
||||
image: linuxserver/htpcmanager
|
||||
container_name: htpcmanager
|
||||
environment:
|
||||
- PUID=1001
|
||||
- PGID=1001
|
||||
- TZ=Europe/London
|
||||
volumes:
|
||||
- </path/to/appdata/config>:/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.`
|
||||
Container 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.
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| `-p 8085` | Application WebUI |
|
||||
| `-e PUID=1001` | for UserID - see below for explanation |
|
||||
| `-e PGID=1001` | for GroupID - see below for explanation |
|
||||
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
| `-v /config` | Configuration files. |
|
||||
|
||||
* `-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
|
||||
## User / Group Identifiers
|
||||
|
||||
It is based on alpine-linux with s6 overlay, for shell access whilst the container is running do `docker exec -it htpcmanager /bin/bash`.
|
||||
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.
|
||||
|
||||
### 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:
|
||||
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
$ id <dockeruser>
|
||||
$ id username
|
||||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
||||
```
|
||||
|
||||
## Setting up the application
|
||||
|
||||
The webui is found at port 8085.
|
||||
|
||||
## Application Setup
|
||||
|
||||
Smartmontools has not been included, you can safely ignore the warning error in the log.
|
||||
The webui is found at port 8085. 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`
|
||||
## 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`
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/manager`
|
||||
## Updating Info
|
||||
|
||||
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
|
||||
|
||||
Below are the instructions for updating containers:
|
||||
|
||||
### Via Docker Run/Create
|
||||
* Update the image: `docker pull linuxserver/htpcmanager`
|
||||
* Stop the running container: `docker stop htpcmanager`
|
||||
* Delete the container: `docker rm htpcmanager`
|
||||
* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
|
||||
* Start the new container: `docker start htpcmanager`
|
||||
* You can also remove the old dangling images: `docker image prune`
|
||||
|
||||
### Via Docker Compose
|
||||
* Update the image: `docker-compose pull linuxserver/htpcmanager`
|
||||
* Let compose update containers as necessary: `docker-compose up -d`
|
||||
* You can also remove the old dangling images: `docker image prune`
|
||||
|
||||
## 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.
|
||||
|
||||
136
readme-vars.yml
136
readme-vars.yml
@ -2,100 +2,56 @@
|
||||
|
||||
# project information
|
||||
project_name: htpcmanager
|
||||
full_custom_readme: |
|
||||
{% raw -%}
|
||||
[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/
|
||||
project_url: "https://url.com/"
|
||||
project_logo: "https://github.com/Hellowlol/HTPC-Manager"
|
||||
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) is a front end for many htpc related applications. Hellowlol version."
|
||||
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
|
||||
|
||||
[][linuxserverurl]
|
||||
# supported architectures
|
||||
available_architectures:
|
||||
- { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
|
||||
- { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
|
||||
- { arch: "{{ arch_armhf }}", tag: "arm32v6-latest"}
|
||||
|
||||
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/htpcmanager
|
||||
[](https://microbadger.com/images/linuxserver/htpcmanager "Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/htpcmanager "Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-htpcmanager/)
|
||||
|
||||
Htpcmanager, a front end for many htpc related applications. Hellowlol version.[Htpcmanager](https://github.com/Hellowlol/HTPC-Manager)
|
||||
|
||||
[][appurl]
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
docker create --name=htpcmanager \
|
||||
-v <path to data>:/config \
|
||||
-e PGID=<gid> -e PUID=<uid> \
|
||||
-e TZ=<timezone> \
|
||||
-p 8085:8085 \
|
||||
linuxserver/htpcmanager
|
||||
```
|
||||
|
||||
## 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.`
|
||||
# development version
|
||||
development_versions: false
|
||||
development_versions_items:
|
||||
- { tag: "latest", desc: "Stable Ombi releases" }
|
||||
- { tag: "development", desc: "Releases from the `develop` branch of Ombi" }
|
||||
|
||||
|
||||
* `-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
|
||||
# container parameters
|
||||
common_param_env_vars_enabled: true #PGID, PUID, etc, you can set it to 'optional'
|
||||
param_container_name: "{{ project_name }}"
|
||||
param_usage_include_env: true
|
||||
param_env_vars:
|
||||
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." }
|
||||
param_usage_include_vols: true
|
||||
param_volumes:
|
||||
- { vol_path: "/config", vol_host_path: "</path/to/appdata/config>", desc: "Configuration files." }
|
||||
param_usage_include_ports: true
|
||||
param_ports:
|
||||
- { external_port: "8085", internal_port: "8085", port_desc: "Application WebUI" }
|
||||
|
||||
It is based on alpine-linux with s6 overlay, for shell access whilst the container is running do `docker exec -it htpcmanager /bin/bash`.
|
||||
# application setup block
|
||||
app_setup_block_enabled: true
|
||||
app_setup_block: "The webui is found at port 8085. Smartmontools has not been included, you can safely ignore the warning error in the log."
|
||||
|
||||
app_setup_nginx_reverse_proxy_snippet: false
|
||||
app_setup_nginx_reverse_proxy_block: ""
|
||||
# changelog
|
||||
|
||||
### 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 <dockeruser>
|
||||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
||||
```
|
||||
|
||||
## Setting up the application
|
||||
|
||||
The webui is found at port 8085.
|
||||
|
||||
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`
|
||||
|
||||
|
||||
## 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.
|
||||
{%- endraw %}
|
||||
changelogs:
|
||||
- { date: "16.01.19:", desc: "Add pipeline logic and multi arch." }
|
||||
- { date: "17.08.18:", desc: "Rebase to alpine 3.8." }
|
||||
- { date: "12.12.17:", desc: "Rebase to alpine 3.7." }
|
||||
- { date: "20.07.17:", desc: "Internal git pull instead of at runtime." }
|
||||
- { date: "25.05.17:", desc: "Rebase to alpine 3.6." }
|
||||
- { date: "07.02.17:", desc: "Rebase to alpine 3.5." }
|
||||
- { date: "14.10.16:", desc: "Add version layer information." }
|
||||
- { date: "26.09.16:", desc: "Add back cherrypy after removal from baseimage." }
|
||||
- { date: "10.09.16:", desc: "Add layer badges to README." }
|
||||
- { date: "28.08.16:", desc: "Add badges to README." }
|
||||
- { date: "08.08.16:", desc: "Rebase to alpine linux." }
|
||||
- { date: "14.01.15:", desc: "Remove hardcoded loglevel from the run command, set in webui" }
|
||||
- { date: "19.09.15:", desc: "Initial Release." }
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user