initial commit

Author: melonarc

.github/workflows/BuildImage.yml

@@ -5,8 +5,8 @@ on: [push, pull_request_target, workflow_dispatch]
 env:
   GITHUB_REPO: "linuxserver/docker-mods" #don't modify
   ENDPOINT: "linuxserver/mods" #don't modify
-  BASEIMAGE: "replace_baseimage" #replace
-  MODNAME: "replace_modname" #replace
+  BASEIMAGE: "nextcloud" #replace
+  MODNAME: "notify-push" #replace
   MULTI_ARCH: "true" #set to false if not needed
 
 jobs:

Dockerfile

@@ -2,7 +2,7 @@
 
 FROM scratch
 
-LABEL maintainer="username"
+LABEL maintainer="melonarc"
 
 # copy local files
 COPY root/ /

Dockerfile.complex

@@ -1,25 +1,89 @@
-# Rsync - Docker mod for openssh-server
+# nextcloud-notify-push - Docker mod for Nextcloud  
 
-This mod adds rsync to openssh-server, to be installed/updated during container start.
+This mod adds a service to start the [notify-push](https://github.com/nextcloud/notify_push) binary.
 
-In openssh-server docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:openssh-server-rsync`
+## Requirements
 
-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`
+- Redis configured in your config.php
 
-# Mod creation instructions
+## Setup
 
-* 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.
+1. Download and install the "client-push" (``notify-push``) app from the Nextcloud store.
 
+2. Add ``DOCKER_MODS=linuxserver/mods:nextcloud-notify-push`` to your env.
 
-## Tips and tricks
+3. notify_push should be running and ``**** Starting notify-push ****`` appear in the log. Also check for errors.
 
-* 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)
+4. [Configure your reverse proxy for notify push.](https://github.com/nextcloud/notify_push#reverse-proxy)
+
+5. run ``occ notify_push:setup https://cloud.example.org/push`` to test and enable notify-push, replace "*cloud.example.org*" with your domain.
+
+### Traefik configuration
+
+notify-push listens on its own port, therefore we need to to forward all traffic under example.org/push/* to port 7867.
+
+We need to add an additional router and service to the container. Having more than one router requires to explicitly configure more options. Additionally a new middleware to strip the /push prefix.
+
+Replace "*cloud.example.org*" for both routers with your domain!
+
+#### Before
+
+```yaml
+    ...
+    labels:
+        - "traefik.enable=true"
+        - "traefik.http.routers.nextcloud.entryPoints=https"
+        - "traefik.http.routers.nextcloud.rule=Host(`cloud.example.org`)"
+        - "traefik.http.services.nextcloud.loadbalancer.server.port=443"
+```
+
+#### After
+
+```yaml
+    ...
+    labels:
+        # Nextcloud
+        - "traefik.enable=true"
+        - "traefik.http.routers.nextcloud.entryPoints=https"
+        - "traefik.http.routers.nextcloud.rule=Host(`cloud.example.org`)"
+        - "traefik.http.services.nextcloud.loadbalancer.server.port=443"
+        # add service
+        - "traefik.http.routers.nextcloud.service=nextcloud"
+
+        #Notify-push
+        # forward cloud.example.org/push/*
+        - "traefik.http.routers.nextcloud_push.rule=Host(`cloud.example.org`) && PathPrefix(`/push`)"
+        # entry point
+        - "traefik.http.routers.nextcloud_push.entryPoints=https"
+        # set protocol to http
+        - "traefik.http.services.nextcloud_push.loadbalancer.server.scheme=http"
+        # set port
+        - "traefik.http.services.nextcloud_push.loadbalancer.server.port=7867"
+        # use middleware
+        - "traefik.http.routers.nextcloud_push.middlewares=nextcloud_strip_push"
+        # define middleware
+        - "traefik.http.middlewares.nextcloud_strip_push.stripprefix.prefixes=/push"
+        # add service
+        - "traefik.http.routers.nextcloud_push.service=nextcloud_push"
+
+```
+
+## Validation
+
+1. Read the section about the [Test client](https://github.com/nextcloud/notify_push#test-client). Create an app password and connect to your server
+
+    ```sh
+    test_client https://cloud.example.com username password
+    ```
+
+2. Run ``occ notify_push:metrics``. Step 1 can be skipped if real clients are already connected.
+
+    ```sh
+    root@1d0f9bf7fff9:/# occ notify_push:metrics
+    Active connection count: 2
+    Active user count: 1
+    Total connection count: 5
+    Total database query count: 1
+    Events received: 13
+    Messages sent: 3
+    ```