Merge pull request #543 from linuxserver/homeassistant-hacs-initial

Initial release

.github/workflows/BuildImage.yml

@@ -4,8 +4,8 @@ on: [push, pull_request, workflow_dispatch]
 
 env:
   ENDPOINT: "linuxserver/mods" #don't modify
-  BASEIMAGE: "replace_baseimage" #replace
+  BASEIMAGE: "homeassistant" #replace
-  MODNAME: "replace_modname" #replace
+  MODNAME: "hacs" #replace
 
 jobs:
   build:

Dockerfile

@@ -1,6 +1,6 @@
 FROM scratch
 
-LABEL maintainer="username"
+LABEL maintainer="aptalca"
 
 # copy local files
 COPY root/ /

Dockerfile.complex

@@ -1,23 +0,0 @@
-## Buildstage ##
-FROM ghcr.io/linuxserver/baseimage-alpine:3.15 as buildstage
-
-RUN \
-  echo "**** install packages ****" && \
-  apk add --no-cache \
-    curl && \
-  echo "**** grab rclone ****" && \
-  mkdir -p /root-layer && \
-  curl -o \
-    /root-layer/rclone.deb -L \
-    "https://downloads.rclone.org/v1.47.0/rclone-v1.47.0-linux-amd64.deb"
-
-# copy local files
-COPY root/ /root-layer/
-
-## Single layer deployed image ##
-FROM scratch
-
-LABEL maintainer="username"
-
-# Add files from buildstage
-COPY --from=buildstage /root-layer/ /

README.md

@@ -1,27 +1,12 @@
-# Rsync - Docker mod for openssh-server
+# HACS - Docker mod for Home Assistant
 
-This mod adds rsync to openssh-server, to be installed/updated during container start.
+This mod adds Home Assistant Community Store (HACS) to Home Assistant, to be installed during container start.
 
-In openssh-server docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:openssh-server-rsync`
+In Home Assistant docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:homeassistant-hacs`
+To enable in Home Assistant, add integration `HACS` in the gui and go through the wizard (need to set up Github Oauth).
 
-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-hacs|linuxserver/mods:custom-mod2`
 
-# Mod creation instructions
+## Notes:
-
+- The developer of HACS only supports official Home Assistant installs (Linuxserver image is not official), therefore they will not support this method of installation. Please see here for support info: https://www.linuxserver.io/support
-* Fork the repo, create a new branch based on the branch `template`.
+- HACS does not contain add-ons, as add-ons are docker container based and are only supported in Home Assistant OS/Supervised.
-* 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.
-* The mod should be compatible with both s6v2 and s6v3 (until s6v2 based baseimages are deprecated).
-* After all init scripts and services are created, run `find ./ -name run -exec chmod +x {} +; find ./ -name finish -exec chmod +x {} +` to fix permissions.
-* Edit this readme with pertinent info, delete these instructions.
-* Finally edit the `.github/workflows/BuildImage.yml`. Customize the build branch, and the vars for `BASEIMAGE` and `MODNAME`.
-* 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
-
-* To decrease startup times when multiple mods are used, we have consolidated `apt-get update` down to one file. As seen in the [nodejs mod](https://github.com/linuxserver/docker-mods/tree/code-server-nodejs/root/etc/cont-init.d)
-* Some images has 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)

root/etc/cont-init.d/95-apt-get

@@ -1,5 +0,0 @@
-#!/usr/bin/with-contenv bash
-
-if [ -f /usr/bin/apt ]; then
-    apt-get update
-fi

root/etc/cont-init.d/98-hacs

@@ -0,0 +1,14 @@
+#!/usr/bin/with-contenv bash
+
+if [ -d /config/custom_components/hacs ]; then
+  echo "**** HACS already installed, skipping ****"
+else
+  echo "**** Installing HACS ****"
+  curl -o /tmp/hacs.zip \
+    -fL "https://github.com/hacs/integration/releases/latest/download/hacs.zip"
+  mkdir -p /config/custom_components/hacs
+  unzip /tmp/hacs.zip -d /config/custom_components/hacs
+  chown abc:abc /config/custom_components
+  chown -R abc:abc /config/custom_components/hacs
+  rm -rf /tmp/hacs.zip
+fi

root/etc/cont-init.d/98-vpn-config

@@ -1,26 +0,0 @@
-#!/usr/bin/with-contenv bash
-
-# Determine if setup is needed
-if [ ! -f /usr/local/lib/python***/dist-packages/sshuttle ] && \
-[ -f /usr/bin/apt ]; then
-  ## Ubuntu
-  apt-get install --no-install-recommends -y \
-    iptables \
-    openssh-client \
-    python3 \
-    python3-pip 
-  pip3 install sshuttle
-fi
-if [ ! -f /usr/lib/python***/site-packages/sshuttle ] && \
-[ -f /sbin/apk ]; then
-  # Alpine
-  apk add --no-cache \
-    iptables \
-    openssh \
-    py3-pip \
-    python3 
-  pip3 install sshuttle
-fi
-
-chown -R root:root /root
-chmod -R 600 /root/.ssh

root/etc/s6-overlay/s6-rc.d/init-mod-homeassistant-hacs-install/run

@@ -0,0 +1,14 @@
+#!/usr/bin/with-contenv bash
+
+if [ -d /config/custom_components/hacs ]; then
+  echo "**** HACS already installed, skipping ****"
+else
+  echo "**** Installing HACS ****"
+  curl -o /tmp/hacs.zip \
+    -fL "https://github.com/hacs/integration/releases/latest/download/hacs.zip"
+  mkdir -p /config/custom_components/hacs
+  unzip /tmp/hacs.zip -d /config/custom_components/hacs
+  chown abc:abc /config/custom_components
+  chown -R abc:abc /config/custom_components/hacs
+  rm -rf /tmp/hacs.zip
+fi

root/etc/s6-overlay/s6-rc.d/init-mod-homeassistant-hacs-install/up

@@ -0,0 +1 @@
+/etc/s6-overlay/s6-rc.d/init-mod-homeassistant-hacs-install/run

root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-add-package/run

@@ -1,30 +0,0 @@
-#!/usr/bin/with-contenv bash
-
-# This is the init file used for adding os or pip packages to install lists.
-# It takes advantage of the built-in init-mods-package-install init script that comes with the baseimages.
-# If using this, we need to make sure we set this init as a dependency of init-mods-package-install so this one runs first
-
-if ! command -v apprise; then
-    echo "**** Adding apprise and its deps to package install lists ****"
-    echo "apprise" >> /mod-pip-packages-to-install.list
-    ## Ubuntu
-    if [ -f /usr/bin/apt ]; then
-        echo "\
-            python3 \
-            python3-pip \
-            runc" >> /mod-repo-packages-to-install.list
-    fi
-    # Alpine
-    if [ -f /sbin/apk ]; then
-        echo "\
-            cargo \
-            libffi-dev \
-            openssl-dev \
-            python3 \
-            python3-dev \
-            python3 \
-            py3-pip" >> /mod-repo-packages-to-install.list
-    fi
-else
-    echo "**** apprise already installed, skipping ****"
-fi

root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-add-package/up

@@ -1 +0,0 @@
-/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-add-package/run

root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-install/run

@@ -1,8 +0,0 @@
-#!/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 apprise ****"
-apprise blah blah

root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-install/type

@@ -1 +0,0 @@
-oneshot

root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-install/up

@@ -1 +0,0 @@
-/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-install/run

root/etc/s6-overlay/s6-rc.d/svc-mod-imagename-modname/run

@@ -1,7 +0,0 @@
-#!/usr/bin/with-contenv bash
-
-# This is an example service that would run for the mod
-# It depends on init-services, the baseimage hook for start of all longrun services
-
-exec \
-    s6-setuidgid abc run my app

root/etc/s6-overlay/s6-rc.d/svc-mod-imagename-modname/type

@@ -1 +0,0 @@
-longrun

root/etc/services.d/sshvpn/run

@@ -1,3 +0,0 @@
-#!/usr/bin/with-contenv bash
-
-sshuttle --dns --remote root@${HOST}:${PORT} 0/0 -x 172.17.0.0/16