diff --git a/.travis.yml b/.travis.yml index e6e5b1f..1614243 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,16 +4,16 @@ language: shell branches: only: - - - #replace variables, omit brackets + - healthchecks-apprise services: - docker env: global: - - DOCKERHUB="linuxserver/mods" #don't modify - - BASEIMAGE="baseimagename" #replace - - MODNAME="modname" #replace + - DOCKERHUB="linuxserver/mods" + - BASEIMAGE="healthchecks" + - MODNAME="apprise" jobs: include: diff --git a/Dockerfile.complex b/Dockerfile.complex deleted file mode 100644 index 4463d83..0000000 --- a/Dockerfile.complex +++ /dev/null @@ -1,21 +0,0 @@ -## Buildstage ## -FROM lsiobase/alpine:3.9 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 - -# Add files from buildstage -COPY --from=buildstage /root-layer/ / diff --git a/README.md b/README.md index 2418e53..c7d7166 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,41 @@ -# Rsync - Docker mod for openssh-server +# Healtchecks Apprise mod layer -This mod adds rsync to openssh-server, to be installed/updated during container start. +This is a docker mod layer adding [Apprise](https://github.com/caronc/apprise) to the [linuxserver/docker-healthchecks](https://github.com/linuxserver/docker-healthchecks) docker image. -In openssh-server docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:openssh-server-rsync` +To use this docker mod set the environment variable `DOCKER_MODS` to `linuxserver/mods:healthchecks-apprise`. If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:healtchecks-mod1|linuxserver/mods:healthcheck-apprise`. -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` +Example with docker-compose: -# Mod creation instructions +```yaml +version: "2.1" +services: + healthchecks: + image: linuxserver/healthchecks + container_name: healthchecks + environment: + - PUID=1000 + - PGID=1000 + - DOCKER_MODS=linuxserver/mods:healthchecks-apprise + - SITE_ROOT=SITE_ROOT + - SITE_NAME=SITE_NAME + - DEFAULT_FROM_EMAIL=DEFAULT_FROM_EMAIL + - EMAIL_HOST=EMAIL_HOST + - EMAIL_PORT=EMAIL_PORT + - EMAIL_HOST_USER=EMAIL_HOST_USER + - EMAIL_HOST_PASSWORD=EMAIL_HOST_PASSWORD + - EMAIL_USE_TLS=True or False + - ALLOWED_HOSTS=ALLOWED_HOSTS + - SUPERUSER_EMAIL=SUPERUSER_EMAIL + - SUPERUSER_PASSWORD=SUPERUSER_PASSWORD + volumes: + - path to data on host:/config + ports: + - 8000:8000 + restart: unless-stopped +``` -* Ask the team to create a new branch named `-`. Baseimage should be the name of the image the mod will be applied to. The new branch will be based on the `template` branch. -* Fork the repo, checkout the newly created branch. -* 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. -* Edit this readme with pertinent info, delete these instructions. -* Finally edit the `travis.yml`. Customize the build branch, and the vars for `BASEIMAGE` and `MODNAME`. -* Submit PR against the branch created by the team. \ No newline at end of file +Note that you will also have to enable Apprise in the [Healthchecks](https://github.com/healthchecks/healthchecks#apprise) application. To do so add the following line to the file `local_settings.py`: + +```python +APPRISE_ENABLED=True +``` diff --git a/root/etc/cont-init.d/29-apprise-install b/root/etc/cont-init.d/29-apprise-install new file mode 100644 index 0000000..9d20cd2 --- /dev/null +++ b/root/etc/cont-init.d/29-apprise-install @@ -0,0 +1,7 @@ +#!/usr/bin/with-contenv bash + +# Install Apprise +if [ ! -f /usr/bin/apprise ]; then + echo "Running Custom installation of Apprise" + pip3 install --no-cache-dir apprise +fi \ No newline at end of file diff --git a/root/etc/cont-init.d/98-vpn-config b/root/etc/cont-init.d/98-vpn-config deleted file mode 100644 index a5f9127..0000000 --- a/root/etc/cont-init.d/98-vpn-config +++ /dev/null @@ -1,27 +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 update - 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 diff --git a/root/etc/services.d/sshvpn/run b/root/etc/services.d/sshvpn/run deleted file mode 100644 index 7d49e79..0000000 --- a/root/etc/services.d/sshvpn/run +++ /dev/null @@ -1,3 +0,0 @@ -#!/usr/bin/with-contenv bash - -sshuttle --dns --remote root@${HOST}:${PORT} 0/0 -x 172.17.0.0/16