Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/BuildImage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ on:
env:
GITHUB_REPO: "linuxserver/docker-mods" #don't modify
ENDPOINT: "linuxserver/mods" #don't modify
BASEIMAGE: "replace_baseimage" #replace
MODNAME: "replace_modname" #replace
BASEIMAGE: "homeassistant" #replace
MODNAME: "heyu" #replace
MOD_VERSION: ${{ inputs.mod_version }} #don't modify
MULTI_ARCH: "true" #set to false if not needed

Expand Down
32 changes: 29 additions & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,8 +1,34 @@
# syntax=docker/dockerfile:1

FROM scratch
## Buildstage ##
FROM ghcr.io/linuxserver/baseimage-alpine:3.22 AS buildstage

LABEL maintainer="username"
ARG GIT_HASH=902a4ef

# copy local files
COPY root/ /
COPY root/ /root-layer/

RUN \
echo "**** install build packages ****" && \
apk add --no-cache \
curl build-base && \
echo "**** get heyu source ****" && \
mkdir -p /build && \
cd /build && \
curl -LsSo heyu.zip https://github.com/HeyuX10Automation/heyu/archive/${GIT_HASH}.zip && \
unzip heyu.zip && \
mv heyu-* heyu && \
cd heyu && \
echo "**** building heyu ****" && \
./configure --sysconfdir=/config/heyu/ && \
make && \
make install prefix=/root-layer sysconfdir=/root-layer/defaults && \
cd /

## Single layer deployed image ##
FROM scratch

LABEL maintainer="dcflachs"

# Add files from buildstage
COPY --from=buildstage /root-layer/ /
33 changes: 0 additions & 33 deletions Dockerfile.complex

This file was deleted.

26 changes: 6 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,11 @@
# Rsync - Docker mod for openssh-server
# Heyu - Docker mod for homeassistant

This mod adds rsync to openssh-server, to be installed/updated during container start.
This mod adds heyu to homeassistant, to be installed/updated during container start.

In openssh-server docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:openssh-server-rsync`
In homeassistant docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:homeassistant-heyu`

If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:openssh-server-rsync|linuxserver/mods:openssh-server-mod2`
If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:homeassistant-heyu|linuxserver/mods:homeassistant-hacs`

# Mod creation instructions
# Mod config instructions

* Fork the repo, create a new branch based on the branch `template`.
* Edit the `Dockerfile` for the mod. `Dockerfile.complex` is only an example and included for reference; it should be deleted when done.
* Inspect the `root` folder contents. Edit, add and remove as necessary.
* After all init scripts and services are created, run `find ./ -path "./.git" -prune -o \( -name "run" -o -name "finish" -o -name "check" \) -not -perm -u=x,g=x,o=x -print -exec chmod +x {} +` to fix permissions.
* Edit this readme with pertinent info, delete these instructions.
* Finally edit the `.github/workflows/BuildImage.yml`. Customize the vars for `BASEIMAGE` and `MODNAME`. Set the versioning logic and `MULTI_ARCH` if needed.
* Ask the team to create a new branch named `<baseimagename>-<modname>`. Baseimage should be the name of the image the mod will be applied to. The new branch will be based on the `template` branch.
* Submit PR against the branch created by the team.


## Tips and tricks

* Some images have helpers built in, these images are currently:
* [Openvscode-server](https://github.com/linuxserver/docker-openvscode-server/pull/10/files)
* [Code-server](https://github.com/linuxserver/docker-code-server/pull/95)
Heyu cannot be configured through the homeassistant interface. To configure heyu edit the config file at `/config/heyu/x10.conf`
21 changes: 21 additions & 0 deletions root/etc/s6-overlay/s6-rc.d/init-mod-homeassistant-heyu-setup/run
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
#!/usr/bin/with-contenv bash

# This is an install script that is designed to run after init-mods-package-install
# so it can take advantage of packages installed
# init-mods-end depends on this script so that later init and services wait until this script exits

echo "**** Setting up heyu ****"

mkdir -p /config/heyu
mkdir -p /usr/local/var/tmp/heyu
mkdir -p /usr/local/var/lock

if [[ ! -f /config/heyu/x10.conf ]]; then
cp /defaults/x10config.sample /config/heyu/x10.conf
fi

if [[ ! -f /config/heyu/x10.sched ]]; then
cp /defaults/x10.sched.sample /config/heyu/x10.sched
fi

echo "**** heyu setup complete ****"
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/etc/s6-overlay/s6-rc.d/init-mod-homeassistant-heyu-setup/run

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

7 changes: 0 additions & 7 deletions root/etc/s6-overlay/s6-rc.d/svc-mod-imagename-modname/run

This file was deleted.

1 change: 0 additions & 1 deletion root/etc/s6-overlay/s6-rc.d/svc-mod-imagename-modname/type

This file was deleted.

Empty file.