changes build process + readme
This commit is contained in:
24
README.md
24
README.md
@@ -1,30 +1,24 @@
|
||||
# hyperion-docker
|
||||
|
||||
This repository is based on the work of [psychowood](https://github.com/psychowood/hyperion.ng-docker) although it has suffered some modifications.
|
||||
|
||||

|
||||

|
||||
|
||||
This is a simple repository containining some the source files that enable you tu run [hyperiong.ng](https://github.com/hyperion-project/hyperion.ng/#readme) in a docker container.
|
||||
You can choose between building the image yourself or using the image that's published in this repositoru.
|
||||
This is a simple repository containing the source files that enable you tu run [hyperiong.ng](https://github.com/hyperion-project/hyperion.ng/#readme) in a docker container.
|
||||
You can choose between building the image yourself or using the image that's published in this repository.
|
||||
|
||||
The image is quite simple:
|
||||
This repository initially was based on the work of [psychowood](https://github.com/psychowood/hyperion.ng-docker).
|
||||
Upon putting further thought into it seemed necesasary to use a custom build instead of the official deb packages.
|
||||
|
||||
1. It's based on the [official Debian 12 (bookworm) docker image](https://hub.docker.com/_/debian)
|
||||
2. It downloads the hyperion official package from the [official hyperion apt package repository](https://apt.releases.hyperion-project.org/)
|
||||
|
||||
The image has the following characteristics:
|
||||
|
||||
1. It's based on the [official Debian 13 (trixie) docker image](https://hub.docker.com/_/debian)
|
||||
2. It includes a custom build of hyperion designed to take away uncecesarry dependencies
|
||||
3. Maps the `/config` dirctory as an external volume, to keep your settings
|
||||
4. Runs hyperiond service as non-root user. Default UID:GID are 1000:1000 but they can be easily changed through environment variables
|
||||
|
||||
Sadly, the resulting image is not exaclty slim at ~500MB, because hyperion has lots of dependencies. Since many of them are for the Desktop/Qt UI, it should be possible to slim the image up by cherry picking the ones not used but the cli service, but that's probably not really worth it.
|
||||
|
||||
On the other hand, the running service does not need lots of RAM (on my system takes ~64MB without the cache).
|
||||
|
||||
You have different options to run this image, after starting the container you can reach the web ui going either to http://youdockerhost:8090 or https://youdockerhost:8092
|
||||
|
||||
### Standard configuration
|
||||
|
||||
|
||||
```
|
||||
start the container with `docker compose up -d` with the following `docker-compose.yml` :
|
||||
```yaml
|
||||
version: '3.3'
|
||||
|
||||
Reference in New Issue
Block a user