fixed windows-wysiwyg installation and container (watcher)

Author: guFalcon

README.md

@@ -28,7 +28,7 @@ If you'd like to host your own files, you'll have to fork this repository.
 	* Generate different views on a document to keep exam-questions, answers and testing-questions together in one document.
 * Full Obsidian-flavor Markdown support
 * Switch between teacher- and student-view
-* Local [WYSIWIG Editor Setup](docs-wysiwig.md) that allows you to see the changes to your documents instantly.
+* Local [WYSIWYG Editor Setup](docs-wysiwyg.md) that allows you to see the changes to your documents instantly.
 ### Features for Students
 * Availability
 	* Teaching materials are always up-to-date
@@ -86,8 +86,8 @@ So there are some intricacies you should be aware of when working with it and se
 	  If you'd like to use any other server, set your secret accordingly.
 ## Obsidian Language Extensions
 Here you can find the technical intricacies of the Obsidian-specific language extension implemented in this project [docs](docs-obsidian.md).
-## Local WYSIWIG Container
-Start a container running the server, which is exposing a web-page and constantly scanning for changes in your files [here](docs-wysiwig.md).
+## Local WYSIWYG Container
+Start a container running the server, which is exposing a web-page and constantly scanning for changes in your files [here](docs-wysiwyg.md).
 ## Permissions
 You can specify who is able to read whole files, or only parts of it.
 Here you can find more information about [permissions](docs-permissions.md).

docs-wysiwig.md renamed to docs-wysiwyg.md

@@ -1,18 +1,19 @@
-# WYSIWIG 
+# WYSIWYG 
 If you'd like to run a local container of this server in order to see changes you make on your files on-the-fly, you've come to the right page.
 
 [Back](README.md) to the main page.
 ## How to setup your local container
 ### Prerequisites
-- Local [Docker](https://docker.com)-installation
+- Local [Docker](https://docker.com)-installation (or Docker-Desktop for Windows-installations)
 - Some access to the keycloak-server that's being used (may be local, or the standard remote one)
 - Free port `8081` on your local machine (you may change that, but it has to be configured on the keycloak-client as a `valid redirect URL` like `http://localhost:<port>/*`)
 ### Installation
 - Clone this repository
-- Copy the contents of the directory `local-wysiwig-container` to your local host
+- Copy the contents of the directory `wysiwyg-container-linux` or `wysiwyg` to your local host
+- **Windows-Only:** Open Docker-Desktop UI and go to Settings -> Resources -> File Sharing. Add your directory to the shared drives this way (the `\md` subdir).
 - Adjust the contents of the `.env` file
 - Adjust the contents of the `keycloak.json` file
-- Run `up.sh` to start your container as a persistent container
+- Run `./up.sh` on linux or `./up.ps1` on windows to start your container as a persistent container
 ### `.env` File
 
 | Field             | Example-value                    | Description                                                                                                                                                                                                                                                |
@@ -31,3 +32,9 @@ This should be self-explanatory for keycloak-users. It's the config file for the
 | auth-server-url | The full URL to the server.       |
 | resource        | The client of your application.   |
 | secret          | The client-secret of your client. |
+### Windows-Explanation
+There is a bit of a problem with file mounts on windows / WSL and programs running in either of those two contexts.
+While you may access `\\wsl$\<distro>\home\<user>\` from your Windows-context and `/mnt/c/utils/` from you WSL context, the file-events are not propagated over this border (and changes propagate slowly).
+On Windows machines you may either choose to...
+- ...fully use WSL, clone and push your repo from there using native WSL-installed tools and use the container and files in the `wysiwyg-container-linux`.
+- ...fully use Windows, clone and push your repo from there using native Windows-installed tools and use the container and files in the `wysiwyg-container-windows` directory. Then you have to use Powershell to start and stop the container.

local-wysiwyg-container/.env renamed to wysiwyg-container-linux/.env

@@ -0,0 +1,13 @@
+WEBSERVER_PORT=8081
+PUBLIC_SERVER_URL=http://localhost:8081
+PUBLIC_START_PAGE=/md/index.md
+
+LOCAL_DEV_MD_DIR=\path\to\your\local\md
+# Don't forget to add your path to the docker-desktop shared drives via
+# Settings -> Resources -> File Sharing.
+# Use baskslash and drive letters here.
+AUTOSCAN=true
+
+INTERNAL_PORT=8080
+DOCKER_HUB_USER=gufalcon
+DOCKER_IMAGE_NAME=safe-learn

local-wysiwyg-container/docker-compose.yml renamed to wysiwyg-container-linux/docker-compose.yml

@@ -0,0 +1,25 @@
+services:
+
+  safeLearn:
+    image: ${DOCKER_HUB_USER}/${DOCKER_IMAGE_NAME}:latest
+    container_name: safeLearn
+    restart: unless-stopped
+    ports:
+      - ${WEBSERVER_PORT}:${INTERNAL_PORT}
+    environment:
+      - NEXT_PUBLIC_SERVER_URL=${PUBLIC_SERVER_URL}
+      - NEXT_PUBLIC_START_PAGE=${PUBLIC_START_PAGE}
+      - NEXT_AUTOSCAN=${AUTOSCAN}
+      # Turn on polling so changes on local windows drives are seen reliably.
+      - CHOKIDAR_USEPOLLING=true
+      - CHOKIDAR_INTERVAL=500
+      - WATCHPACK_POLLING=true
+      - WATCHPACK_POLL_INTERVAL=500
+      - WATCHDOG_FORCE_POLLING=true
+    volumes:
+      - type: bind
+        source: "${LOCAL_DEV_MD_DIR}"
+        target: /app/md
+      - type: bind
+        source: ./keycloak.json
+        target: /app/keycloak.json

local-wysiwyg-container/keycloak.json renamed to wysiwyg-container-linux/keycloak.json

@@ -0,0 +1,12 @@
+{
+  "realm": "realm",
+  "auth-server-url": "https://yourserver.com/",
+  "ssl-required": "external",
+  "resource": "client",
+  "verify-token-audience": false,
+  "credentials": {
+    "secret": "clien-secret"
+  },
+  "use-resource-role-mappings": true,
+  "confidential-port": 0
+}

local-wysiwyg-container/up.sh renamed to wysiwyg-container-linux/up.sh

@@ -0,0 +1,11 @@
+# up.ps1
+$ErrorActionPreference = "Stop"
+Set-Location -Path $PSScriptRoot
+
+Write-Host "Pulling images..." -ForegroundColor Cyan
+docker compose pull
+
+Write-Host "Starting containers..." -ForegroundColor Cyan
+docker compose up -d --force-recreate --remove-orphans
+
+Write-Host "Containers are running (detached)." -ForegroundColor Green