Merge branch 'develop'

.editorconfig

@@ -0,0 +1,17 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+end_of_line = lf
+# editorconfig-tools is unable to ignore longs strings or urls
+max_line_length = off
+
+[CHANGELOG.md]
+indent_size = 4
+
+[*.bat]
+end_of_line = crlf

.env.default

@@ -4,15 +4,15 @@
 # Always ensure to load the env variables in every terminal session.
 # Otherwise the env variables will not be available
 
-DOCKER_COMPOSE_APP_DEV_PORT_PUBLISHED=9001
-DOCKER_COMPOSE_APP_DEV_PORT_TARGET=9001
+DOCKER_COMPOSE_APP_PORT_PUBLISHED=9001
+DOCKER_COMPOSE_APP_PORT_TARGET=9001
 
 # IMPORTANT: When the env var DEFAULT_PAD_TEXT is unset or empty, then the pad is not established (not the landing page).
 # The env var DEFAULT_PAD_TEXT seems to be mandatory in the latest version of etherpad.
 DOCKER_COMPOSE_APP_DEV_ENV_DEFAULT_PAD_TEXT="Welcome to etherpad"
 
-DOCKER_COMPOSE_APP_DEV_ADMIN_PASSWORD=
+DOCKER_COMPOSE_APP_ADMIN_PASSWORD=
 
-DOCKER_COMPOSE_POSTGRES_DEV_ENV_POSTGRES_DATABASE=db
-DOCKER_COMPOSE_POSTGRES_DEV_ENV_POSTGRES_PASSWORD=etherpad-lite-password
-DOCKER_COMPOSE_POSTGRES_DEV_ENV_POSTGRES_USER=etherpad-lite-user
+DOCKER_COMPOSE_POSTGRES_DATABASE=db
+DOCKER_COMPOSE_POSTGRES_PASSWORD=etherpad-lite-password
+DOCKER_COMPOSE_POSTGRES_USER=etherpad-lite-user

.env.dev.default

@@ -0,0 +1,18 @@
+# Please copy and rename this file.
+#
+# !Attention!
+# Always ensure to load the env variables in every terminal session.
+# Otherwise the env variables will not be available
+
+DOCKER_COMPOSE_APP_DEV_PORT_PUBLISHED=9001
+DOCKER_COMPOSE_APP_DEV_PORT_TARGET=9001
+
+# IMPORTANT: When the env var DEFAULT_PAD_TEXT is unset or empty, then the pad is not established (not the landing page).
+# The env var DEFAULT_PAD_TEXT seems to be mandatory in the latest version of etherpad.
+DOCKER_COMPOSE_APP_DEV_ENV_DEFAULT_PAD_TEXT="Welcome to etherpad"
+
+DOCKER_COMPOSE_APP_DEV_ADMIN_PASSWORD=
+
+DOCKER_COMPOSE_POSTGRES_DEV_ENV_POSTGRES_DATABASE=db
+DOCKER_COMPOSE_POSTGRES_DEV_ENV_POSTGRES_PASSWORD=etherpad-lite-password
+DOCKER_COMPOSE_POSTGRES_DEV_ENV_POSTGRES_USER=etherpad-lite-user

.github/workflows/backend-tests.yml

@@ -36,7 +36,7 @@ jobs:
       - uses: pnpm/action-setup@v3
         name: Install pnpm
         with:
-            version: 8
+            version: 9.0.4
             run_install: false
       - name: Get pnpm store directory
         shell: bash
@@ -93,7 +93,7 @@ jobs:
       - uses: pnpm/action-setup@v3
         name: Install pnpm
         with:
-          version: 8
+          version: 9.0.4
           run_install: false
       - name: Get pnpm store directory
         shell: bash
@@ -163,7 +163,7 @@ jobs:
       - uses: pnpm/action-setup@v3
         name: Install pnpm
         with:
-          version: 8
+          version: 9.0.4
           run_install: false
       - name: Get pnpm store directory
         shell: bash
@@ -216,7 +216,7 @@ jobs:
       - uses: pnpm/action-setup@v3
         name: Install pnpm
         with:
-          version: 8
+          version: 9.0.4
           run_install: false
       - name: Get pnpm store directory
         shell: bash

.github/workflows/build-and-deploy-docs.yml

@@ -38,7 +38,7 @@ jobs:
       - uses: pnpm/action-setup@v3
         name: Install pnpm
         with:
-          version: 8
+          version: 9.0.4
           run_install: false
       - name: Get pnpm store directory
         shell: bash

.github/workflows/docker.yml

@@ -47,7 +47,7 @@ jobs:
       - uses: pnpm/action-setup@v3
         name: Install pnpm
         with:
-          version: 8
+          version: 9.0.4
           run_install: false
       - name: Get pnpm store directory
         shell: bash

.github/workflows/frontend-admin-tests.yml

@@ -37,7 +37,7 @@ jobs:
       - uses: pnpm/action-setup@v3
         name: Install pnpm
         with:
-          version: 8
+          version: 9.0.4
           run_install: false
       - name: Get pnpm store directory
         shell: bash

.github/workflows/frontend-tests.yml

@@ -30,7 +30,7 @@ jobs:
       - uses: pnpm/action-setup@v3
         name: Install pnpm
         with:
-          version: 8
+          version: 9.0.4
           run_install: false
       - name: Get pnpm store directory
         shell: bash
@@ -96,7 +96,7 @@ jobs:
       - uses: pnpm/action-setup@v3
         name: Install pnpm
         with:
-          version: 8
+          version: 9.0.4
           run_install: false
       - name: Get pnpm store directory
         shell: bash
@@ -163,7 +163,7 @@ jobs:
       - uses: pnpm/action-setup@v3
         name: Install pnpm
         with:
-          version: 8
+          version: 9.0.4
           run_install: false
       - name: Get pnpm store directory
         shell: bash

.github/workflows/load-test.yml

@@ -32,7 +32,7 @@ jobs:
       - uses: pnpm/action-setup@v3
         name: Install pnpm
         with:
-          version: 8
+          version: 9.0.4
           run_install: false
       - name: Get pnpm store directory
         shell: bash
@@ -76,7 +76,7 @@ jobs:
       - uses: pnpm/action-setup@v3
         name: Install pnpm
         with:
-          version: 8
+          version: 9.0.4
           run_install: false
       - name: Get pnpm store directory
         shell: bash
@@ -147,7 +147,7 @@ jobs:
       - uses: pnpm/action-setup@v3
         name: Install pnpm
         with:
-          version: 8
+          version: 9.0.4
           run_install: false
       - name: Get pnpm store directory
         shell: bash

.github/workflows/perform-type-check.yml

@@ -29,7 +29,7 @@ jobs:
       - uses: pnpm/action-setup@v3
         name: Install pnpm
         with:
-          version: 8
+          version: 9.0.4
           run_install: false
       - name: Get pnpm store directory
         shell: bash

.github/workflows/rate-limit.yml

@@ -32,7 +32,7 @@ jobs:
       - uses: pnpm/action-setup@v3
         name: Install pnpm
         with:
-          version: 8
+          version: 9.0.4
           run_install: false
       - name: Get pnpm store directory
         shell: bash

.github/workflows/upgrade-from-latest-release.yml

@@ -38,7 +38,7 @@ jobs:
       - uses: pnpm/action-setup@v3
         name: Install pnpm
         with:
-          version: 8
+          version: 9.0.4
           run_install: false
       - name: Only install direct dependencies
         run: pnpm config set auto-install-peers false

.github/workflows/windows.yml

@@ -38,7 +38,7 @@ jobs:
       - uses: pnpm/action-setup@v3
         name: Install pnpm
         with:
-          version: 8
+          version: 9.0.4
           run_install: false
       - name: Get pnpm store directory
         shell: bash
@@ -132,7 +132,7 @@ jobs:
       - uses: pnpm/action-setup@v3
         name: Install pnpm
         with:
-          version: 8
+          version: 9.0.4
           run_install: false
       - name: Get pnpm store directory
         shell: bash

CHANGELOG.md

@@ -1,3 +1,13 @@
+# 2.0.3
+
+### Notable enhancements and fixes
+
+- Added documentation for replacing apikeys with oauth2
+- Bumped live plugin manager to 0.20.0. Thanks to @fgreinacher
+- Added better documentation for using docker-compose with Etherpad
+
+
+
 # 2.0.2
 
 ### Notable enhancements and fixes
@@ -25,7 +35,7 @@
 - Socket io has been updated to 4.7.5. This means that the json.send function won't work anymore and needs to be changed to .emit('message', myObj)
 - Deprecating npm version 6 in favor of pnpm: We have made the decision to switch to the well established pnpm (https://pnpm.io/). It works by symlinking dependencies into a global directory allowing you to have a cleaner and more reliable environment.
 - Introducing Typescript to the Etherpad core: Etherpad core logic has been rewritten in Typescript allowing for compiler checking of errors.
-- Rewritten Admin Panel: The Admin panel has been rewritten in React and now features a more pleasant user experience. It now also features an integrated pad searching with sorting functionality. 
+- Rewritten Admin Panel: The Admin panel has been rewritten in React and now features a more pleasant user experience. It now also features an integrated pad searching with sorting functionality.
 
 ### Notable enhancements and fixes
 
@@ -35,7 +45,7 @@
 * Enhancements
   - pnpm Workspaces: In addition to pnpm we introduced workspaces. A clean way to manage multiple bounded contexts like the admin panel or the bin folder.
   - Bin folder: The bin folder has been moved from the src folder to the root folder. This change was necessary as the contained scripts do not represent core functionality of the user.
-  - Starting Etherpad: Etherpad can now be started with a single command: `pnpm run prod` in the root directory. 
+  - Starting Etherpad: Etherpad can now be started with a single command: `pnpm run prod` in the root directory.
   - Installing Etherpad: Etherpad no longer symlinks itself in the root directory. This is now also taken care by pnpm, and it just creates a node_modules folder with the src directory`s ep_etherpad-lite folder
   - Plugins can now be installed simply via the command: `pnpm run install-plugins first-plugin second-plugin` or if you want to install from path you can do:
   `pnpm run install-plugins --path ../path-to-plugin`
@@ -45,7 +55,7 @@
 
 ### Notable enhancements and fixes
 
-* Added Live Plugin Manager: Plugins are now installed into a separate folder on the host system. This folder is called `plugin_packages`. 
+* Added Live Plugin Manager: Plugins are now installed into a separate folder on the host system. This folder is called `plugin_packages`.
 That way the plugins are separated from the normal etherpad installation.
 * Make repairPad.js more verbose
 * Fixed favicon not being loaded correctly
@@ -68,27 +78,27 @@ That way the plugins are separated from the normal etherpad installation.
 
 ### Notable enhancements and fixes
 
-* The support for the tidy program to tidy up HTML files has been removed. This decision was made because it hasn't been updated for years and also caused an incompability when exporting a pad with Abiword. 
+* The support for the tidy program to tidy up HTML files has been removed. This decision was made because it hasn't been updated for years and also caused an incompability when exporting a pad with Abiword.
 
 
 # 1.9.4
 
 ### Compatibility changes
 
-* Log4js has been updated to the latest version. As it involved a bump of 6 major version. 
+* Log4js has been updated to the latest version. As it involved a bump of 6 major version.
   A lot has changed since then. Most notably the console appender has been deprecated. You can find out more about it [here](https://github.com/log4js-node/log4js-node)
 
 ### Notable enhancements and fixes
 
-* Fix for MySQL: The logger calls were incorrectly configured leading to a crash when e.g. somebody uses a different encoding than standard MySQL encoding. 
+* Fix for MySQL: The logger calls were incorrectly configured leading to a crash when e.g. somebody uses a different encoding than standard MySQL encoding.
 
 # 1.9.3
 
 ### Compability changes
 
 * express-rate-limit has been bumped to 7.0.0: This involves the breaking change that "max: 0"
 in the importExportRateLimiting is set to always trigger. So set it to your desired value.
-If you haven't changed that value in the settings.json you are all set. 
+If you haven't changed that value in the settings.json you are all set.
 
 ### Notable enhancements and fixes
 
@@ -107,7 +117,7 @@ If you haven't changed that value in the settings.json you are all set.
   * Enable session key rotation: This setting can be enabled in the settings.json. It changes the signing key for the cookie authentication in a fixed interval.
 
 * Bugfixes
-  * Fix appendRevision when creating a new pad via the API without a text. 
+  * Fix appendRevision when creating a new pad via the API without a text.
 
 
 * Enhancements
@@ -116,19 +126,19 @@ If you haven't changed that value in the settings.json you are all set.
 
 ### Compatibility changes
 
-* No compability changes as JQuery maintains excellent backwards compatibility. 
+* No compability changes as JQuery maintains excellent backwards compatibility.
 
 #### For plugin authors
 
-* Please update to JQuery 3.7. There is an excellent deprecation guide over [here](https://api.jquery.com/category/deprecated/). Version 3.1 to 3.7 are relevant for the upgrade. 
+* Please update to JQuery 3.7. There is an excellent deprecation guide over [here](https://api.jquery.com/category/deprecated/). Version 3.1 to 3.7 are relevant for the upgrade.
 
 # 1.9.1
 
 ### Notable enhancements and fixes
 
 * Security
   * Limit requested revisions in timeslider and export to head revision. (affects v1.9.0)
-  
+
 * Bugfixes
   * revisions in `CHANGESET_REQ` (timeslider) and export (txt, html, custom)
     are now checked to be numbers.
@@ -142,7 +152,7 @@ If you haven't changed that value in the settings.json you are all set.
 * tests: drop windows 7 test coverage & use chrome latest for admin tests
 * Require Node 16 for Etherpad and target Node 20 for testing
 
-    
+
 # 1.9.0
 
 ### Notable enhancements and fixes

Dockerfile

@@ -8,7 +8,7 @@ FROM node:alpine as adminBuild
 
 WORKDIR /opt/etherpad-lite
 COPY ./ ./
-RUN cd ./admin && npm install -g pnpm && pnpm install && pnpm run build --outDir ./dist
+RUN cd ./admin && npm install -g pnpm@9.0.4 && pnpm install && pnpm run build --outDir ./dist
 RUN cd ./ui && pnpm install && pnpm run build --outDir ./dist
 
 
@@ -91,7 +91,7 @@ RUN mkdir -p "${EP_DIR}" && chown etherpad:etherpad "${EP_DIR}"
 # https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=863199
 RUN  \
     mkdir -p /usr/share/man/man1 && \
-    npm install pnpm -g  && \
+    npm install pnpm@9.0.4 -g  && \
     apk update && apk upgrade && \
     apk add --no-cache \
         ca-certificates \