Initial release

This commit is contained in:
aptalca
2022-12-18 14:02:25 -05:00
parent 6745950323
commit ed36fab74c
26 changed files with 41 additions and 132 deletions
+9 -23
View File
@@ -1,27 +1,13 @@
# 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
* 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.
* 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)
## 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
- HACS does not contain add-ons, as add-ons are docker container based and are only supported in Home Assistant OS/Supervised.
-