Merge pull request #96 from JankariTech/opencloud

make extension work also with OpenCloud

Author: individual-it

.github/workflows/ci.yml

@@ -12,20 +12,28 @@ on:
   workflow_call:
 
 env:
-  OCIS_URL: https://localhost:9200
+  OC_URL: https://localhost:9200
 
 jobs:
   lint-and-tests:
+    strategy:
+      matrix:
+        server:
+          - Ocis
+          - Opencloud
     runs-on: ubuntu-latest
     steps:
       - name: checkout
         uses: actions/checkout@v4
 
+      - name: generate-package-json
+        run: make dependencies${{ matrix.server }}
+
       - name: pnpm-install
         uses: pnpm/action-setup@v4
-        with:
-          run_install: |
-            - args: [--frozen-lockfile, --strict-peer-dependencies]
+
+      - name: install
+        run: make install${{ matrix.server }}
 
       - name: lint
         run: pnpm lint
@@ -45,10 +53,11 @@ jobs:
         run: pnpm test:unit --coverage
 
       - name: ocis-server
+        if: matrix.server == 'Ocis'
         run: |
           docker run --rm -d \
             -p 9200:9200 \
-            -e OCIS_URL=$OCIS_URL \
+            -e OCIS_URL=$OC_URL \
             -e OCIS_INSECURE=true \
             -e OCIS_LOG_LEVEL=error \
             -e IDM_ADMIN_PASSWORD=admin \
@@ -61,6 +70,24 @@ jobs:
             owncloud/ocis-rolling:latest \
             -c 'ocis init || true && ocis server'
 
+      - name: opencloud-server
+        if: matrix.server == 'Opencloud'
+        run: |
+          docker run --rm -d \
+            -p 9200:9200 \
+            -e OC_URL=$OC_URL \
+            -e OC_INSECURE=true \
+            -e OC_LOG_LEVEL=error \
+            -e IDM_ADMIN_PASSWORD=admin \
+            -e PROXY_ENABLE_BASIC_AUTH=true \
+            -e PROXY_CSP_CONFIG_FILE_LOCATION=/etc/opencloud/csp.yml \
+            -e WEB_ASSET_APPS_PATH=/web/apps \
+            -v ${{ github.workspace }}/dev/config/csp.yml:/etc/opencloud/csp.yml:ro \
+            -v ${{ github.workspace }}/dist:/web/apps:ro \
+            --entrypoint sh \
+            opencloudeu/opencloud-rolling:latest \
+            -c 'opencloud init || true && opencloud server'
+
       - name: host-ip
         id: host_ip
         run: echo "host_ip=$(hostname -I | cut -d' ' -f1)" >> "$GITHUB_OUTPUT"

.github/workflows/release.yml

@@ -20,11 +20,11 @@ jobs:
 
       - name: create-artifacts
         run: |
-          (cd dist && zip -r - .) >mdpresentation-viewer-${{ github.ref_name }}.zip
+          (cd dist && zip -r - .) >mdpresentation-viewer-${{ matrix.server }}-${{ github.ref_name }}.zip
           mkdir -p dist/release
-          mv mdpresentation-viewer-${{ github.ref_name }}.zip dist/release/
-          md5sum dist/release/mdpresentation-viewer-${{ github.ref_name }}.zip >dist/release/md5sum.txt
-          sha256sum dist/release/mdpresentation-viewer-${{ github.ref_name }}.zip >dist/release/sha256sum.txt
+          mv mdpresentation-viewer-${{ matrix.server }}-${{ github.ref_name }}.zip dist/release/
+          md5sum dist/release/mdpresentation-viewer-${{ matrix.server }}-${{ github.ref_name }}.zip >dist/release/md5sum.txt
+          sha256sum dist/release/mdpresentation-viewer-${{ matrix.server }}-${{ github.ref_name }}.zip >dist/release/sha256sum.txt
 
       - name: publish-artifacts
         uses: fnkr/github-action-ghr@v1

.gitignore

@@ -1,6 +1,7 @@
 node_modules
 dist
 coverage
+pnpm-lock.yaml
 
 # Editor directories and files
 .vscode

Dockerfile

@@ -1,11 +1,12 @@
 FROM owncloudci/nodejs:20 AS stage
+ARG server=Ocis
 
 WORKDIR /extension
 
 COPY . .
-RUN pnpm install
+RUN make install$server
 RUN pnpm build
 
 FROM alpine:3.20
 WORKDIR /app
-COPY --from=stage /extension/dist ./ 
+COPY --from=stage /extension/dist ./

Makefile

@@ -0,0 +1,27 @@
+.PHONY: installOcis installOpencloud dependenciesOcis dependenciesOpencloud install clean package
+
+installOcis: dependenciesOcis install
+
+installOpencloud: dependenciesOpencloud install
+
+dependenciesOcis: clean
+	$(MAKE) package PACKAGE_JSON=package-ocis.json
+	$(MAKE) depencenciesReplacement SOURCE=opencloud-eu DEST=ownclouders
+
+dependenciesOpencloud: clean
+	$(MAKE) package PACKAGE_JSON=package-opencloud.json
+	$(MAKE) depencenciesReplacement SOURCE=ownclouders DEST=opencloud-eu
+
+package:
+	jq -s '.[0] * .[1]' package-common.json $(PACKAGE_JSON) > package.json
+
+depencenciesReplacement:
+	find . -type f \( -name "*.ts" -o -name "*.vue" -o -name "*.prettierrc"  \) -not \( -path "./node_modules/*" -o -path "./dist/*" \) -print0 | xargs -0 sed -i 's/${SOURCE}/${DEST}/g'
+
+clean:
+	rm -f package.json
+	rm -rf dist
+	rm -f pnpm-lock.yaml
+
+install:
+	pnpm install

README.md

@@ -2,7 +2,7 @@
 
 ![cover photo](./images/cover-large.png)
 
-A markdown presentation viewer for [ownCloud web](https://github.com/owncloud/web/) (the webUI of [oCIS](https://github.com/owncloud/ocis/)) using the [reveal.js](https://revealjs.com/) library.
+A markdown presentation viewer for [OpenCloud](https://github.com/opencloud-eu/opencloud/) and [oCIS](https://github.com/owncloud/ocis/) using the [reveal.js](https://revealjs.com/) library.
 
 It allows users to:
 
@@ -11,42 +11,35 @@ It allows users to:
 
 ## Demonstration
 
-- [Demonstation page](https://ocis.in-nepal.de/com.github.jankaritech.mdpresentation-viewer/public/phDIUqntYOMSfcE/presentation.md)
+- [Demonstation page OpenCloud](https://opencloud.in-nepal.de/files/link/public/PHxkrAlpSRaqNNK)
+- [Demonstation page oCIS](https://ocis.in-nepal.de/files/link/public/phDIUqntYOMSfcE)
 - Click on `Open in Presentation Viewer` to view the slides
 
 ## Supported oCIS and Web Versions
 
-- [oCIS](https://github.com/owncloud/ocis) (>= 6.x.x)
-- [Web](https://nodejs.org/en/) (>= 9.x.x)
+- [oCIS](https://github.com/owncloud/ocis) (>= 6.x.x) or [OpenCloud](https://github.com/opencloud-eu/opencloud/) (>= 2.0.0)
 
 ## App Installation
 
-> NOTE: Requires oCIS >= 6.0.0
-
 1. Download the zip file from the [releases page](https://github.com/JankariTech/web-app-presentation-viewer/releases)
 
-   For example: `mdpresentation-viewer-x.x.x.zip`
+   For example: `mdpresentation-viewer-<server>-x.x.x.zip`
 
-2. Extract the zip file to the `apps` directory of the oCIS server.
+2. Extract the zip file to the `apps` directory of the OpenCloud/oCIS server.
 
    Apps directory is set using the `WEB_ASSET_APPS_PATH` environment variable.
 
-### App Installation With [oCIS Deployment](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_full)
+### App Installation With [OpenCloud](https://github.com/opencloud-eu/opencloud/tree/main/deployments/examples/opencloud_full) or [oCIS Deployment](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_full)
 
-1. Copy [`deployments/mdpresentation-viewer.yml`](./deployments/mdpresentation-viewer.yml) into the [web_extensions](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_full/web_extensions)
-subfolder of oCIS full deployment example.
-2. Add `MDPRESENTATION_VIEWER=:web_extensions/mdpresentation-viewer.yml` to the `## oCIS Web Extensions ##` section of the `.env` file of your installation (file is located in `deployments/examples/ocis_full`) and append it to the `COMPOSE_FILE` variable.
+1. Copy the `yml` file that corresponds with your server (OpenCloud or oCIS) from [`deployments/`](./deployments/) into the `web_extensions`
+subfolder.
+2. Add `MDPRESENTATION_VIEWER=:web_extensions/mdpresentation-viewer-<your-server>.yml` to the `Web Extensions` section of the `.env` file of your installation and append it to the `COMPOSE_FILE` variable.
     ```env
-    ## oCIS Web Extensions ##
-    MDPRESENTATION_VIEWER=:web_extensions/mdpresentation-viewer.yml
+    MDPRESENTATION_VIEWER=:web_extensions/mdpresentation-viewer-<your-server>.yml
     
     COMPOSE_FILE=docker-compose.yml${...}${MDPRESENTATION_VIEWER:-}
     ```
-3. Run `docker compose up` to run oCIS with the extensions
-
-  oCIS URL: [ocis.owncloud.test](https://ocis.owncloud.test)
-
-  See the [docs](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_full).
+3. Run `docker compose up` to run the server with the extensions
 
 ## Creating Presentation
 
@@ -59,16 +52,26 @@ This app has the following default slide separators:
 
 ## Development
 
+> [!IMPORTANT] When switching between OpenCloud and oCIS, make sure to clean the browser cache!
+> [!CAUTION] Before commiting changes run `make installOcis` and `make clean`
+
 #### Prerequisites
 
 - [Node.js `v18`](https://nodejs.org/en/)
 - [pnpm `v8`](https://pnpm.io/)
 - [Docker Compose](https://docs.docker.com/compose/)
+- [jq](https://jqlang.org/)
 
 #### 1. Install dependencies:
 
+For OpenCloud:
 ```bash
-pnpm install
+make installOpencloud
+```
+
+For oCIS:
+```bash
+make installOcis
 ```
 
 #### 2. Build the extension
@@ -81,12 +84,29 @@ pnpm build:w
 
 #### 3. Load the extension
 
-> NOTE: Requires oCIS >= 6.0.0
+Run the server with the extension:
 
-Run the oCIS server:
+For OpenCloud:
+```bash
+docker compose -f docker-compose-opencloud.yml up
+```
 
+For oCIS:
 ```bash
-docker compose up
+docker compose -f docker-compose-ocis.yml up
 ```
 
-oCIS URL: [localhost:9200](https://localhost:9200)
+server URL: [localhost:9200](https://localhost:9200)
+
+## Building Docker Container
+
+For OpenCloud:
+```bash
+docker build --build-arg server=Opencloud -t jankaritech/mdpresentation-viewer-opencloud:<version> .
+```
+
+
+For Ocis:
+```bash
+docker build --build-arg server=Ocis -t jankaritech/mdpresentation-viewer-ocis:<version> .
+```

deployments/mdpresentation-viewer.yml …ployments/mdpresentation-viewer-ocis.ymldeployments/mdpresentation-viewer.yml renamed to deployments/mdpresentation-viewer-ocis.yml deployments/mdpresentation-viewer.yml renamed to deployments/mdpresentation-viewer-ocis.yml

@@ -6,7 +6,7 @@ services:
         condition: service_completed_successfully
 
   mdpresentation-viewer:
-    image: jankaritech/mdpresentation-viewer:2.0.0
+    image: jankaritech/mdpresentation-viewer:2.1.0
     volumes:
       - ocis-apps:/apps
     entrypoint:

deployments/mdpresentation-viewer-opencloud.yml

@@ -0,0 +1,14 @@
+---
+services:
+  opencloud:
+    depends_on:
+      mdpresentation-viewer:
+        condition: service_completed_successfully
+
+  mdpresentation-viewer:
+    image: jankaritech/mdpresentation-viewer-opencloud:2.1.0
+    volumes:
+      - opencloud-apps:/apps
+    entrypoint:
+      - /bin/sh
+    command: ["-c", "cp -R /app/* /apps"]

docker-compose.yml docker-compose-ocis.ymldocker-compose.yml renamed to docker-compose-ocis.yml

@@ -0,0 +1,22 @@
+services:
+  opencloud:
+    image: opencloudeu/opencloud-rolling:${OC_IMAGE_TAG:-latest}
+    entrypoint: /bin/sh
+    command: ['-c', 'opencloud init || true && opencloud server']
+    ports:
+      - 9200:9200
+    environment:
+      OC_URL: https://localhost:9200
+      OC_INSECURE: true
+      OC_LOG_LEVEL: error
+      # WEB
+      WEB_ASSET_APPS_PATH: /web/apps
+      # IDM
+      IDM_CREATE_DEMO_USERS: true
+      IDM_ADMIN_PASSWORD: admin
+      # PROXY
+      PROXY_ENABLE_BASIC_AUTH: true
+      PROXY_CSP_CONFIG_FILE_LOCATION: /etc/opencloud/csp.yml
+    volumes:
+      - ./dist:/web/apps:ro
+      - ./dev/config/csp.yml:/etc/opencloud/csp.yml