From 89d68cd9658358dc4cf3aec7eba62b76a0962d8e Mon Sep 17 00:00:00 2001 From: Max Bischof Date: Fri, 7 Jun 2024 09:48:33 +0200 Subject: [PATCH 1/3] Remove unused env vars --- docs/services/etherpad/How it works.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/services/etherpad/How it works.md b/docs/services/etherpad/How it works.md index 42f46c3..b5b1f9d 100644 --- a/docs/services/etherpad/How it works.md +++ b/docs/services/etherpad/How it works.md @@ -9,8 +9,6 @@ - ETHERPAD__PAD_URI - Used for collab editor and lesson to build return url, Used in legacy client to build url - ETHERPAD__NEW_DOMAIN - Used in legacy client to validate url - ETHERPAD__OLD_DOMAIN - Used in legacy client to validate url -- ETHERPAD_API_PATH - Only used in tests. -- ETHERPAD_BASE_URL - Not used. ## Creating and Opening an Etherpad Element on a Column Board From b9d13ec80cad58391d671c61cf19f6f125ad1113 Mon Sep 17 00:00:00 2001 From: Max Bischof Date: Fri, 7 Jun 2024 11:41:59 +0200 Subject: [PATCH 2/3] Add env vars --- docs/services/etherpad/How it works.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/docs/services/etherpad/How it works.md b/docs/services/etherpad/How it works.md index b5b1f9d..c714fb4 100644 --- a/docs/services/etherpad/How it works.md +++ b/docs/services/etherpad/How it works.md @@ -1,14 +1,22 @@ # How it works ## Configuration -- ETHERPAD_COOKIE__EXPIRES_SECONDS - time in seconds after which a session expires -- ETHERPAD_ETHERPAD_COOKIE_RELEASE_THRESHOLD - time in seconds after which a session is not returned to the user -- ETHERPAD_API_KEY - api key used for authentication of schulcloud server requests -- ETHERPAD_URI - Used as base path for api client in nest -- ETHERPAD__PAD_PATH - Used in legacy client to set path on cookie. -- ETHERPAD__PAD_URI - Used for collab editor and lesson to build return url, Used in legacy client to build url -- ETHERPAD__NEW_DOMAIN - Used in legacy client to validate url -- ETHERPAD__OLD_DOMAIN - Used in legacy client to validate url +- FEATURE_ETHERPAD_ENABLED - Used to enable etherpad feature in feathers backend +- FEATURE_COLUMN_BOARD_COLLABORATIVE_TEXT_EDITOR_ENABLED - Enables etherpad feature on column boards + +- ETHERPAD_COOKIE_EXPIRES_SECONDS - Time in seconds after which a session expires +- ETHERPAD_ETHERPAD_COOKIE_RELEASE_THRESHOLD - Time in seconds after which a session is not returned to the user + +- ETHERPAD_API_KEY - Api key used for authentication of schulcloud server requests + +- ETHERPAD_URI - Uri of etherpad api for all calls like create, delete etc. Used as base path for api client in nest and feathers backend. + +- ETHERPAD__PAD_URI - URI to etherpad client api. Used in backend in collaborative text editor and lesson to build return url. Used in legacy client to build url. +- ETHERPAD_OLD_PAD_URI - Used in feathers backend to restrict access to old etherpad urls to lesson context. Only defined in default.schema.json and not in dof-app-deploy +- ETHERPAD__PAD_PATH - Path to etherpad client api. Used in legacy client to set path on cookie. + +- ETHERPAD__NEW_DOMAIN - Etherpad Domain. Used in legacy client to validate url +- ETHERPAD__OLD_DOMAIN - Old Etherpad Domain. Used in legacy client to identify old urls in lessons and transform them to urls with new domain. ## Creating and Opening an Etherpad Element on a Column Board From ef04e5adfc3e6f436dc8d5bc1abd87065d20eb20 Mon Sep 17 00:00:00 2001 From: Max Bischof Date: Mon, 10 Jun 2024 10:56:23 +0200 Subject: [PATCH 3/3] Rename env vars --- docs/services/etherpad/How it works.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/services/etherpad/How it works.md b/docs/services/etherpad/How it works.md index c714fb4..b222c63 100644 --- a/docs/services/etherpad/How it works.md +++ b/docs/services/etherpad/How it works.md @@ -4,12 +4,12 @@ - FEATURE_ETHERPAD_ENABLED - Used to enable etherpad feature in feathers backend - FEATURE_COLUMN_BOARD_COLLABORATIVE_TEXT_EDITOR_ENABLED - Enables etherpad feature on column boards -- ETHERPAD_COOKIE_EXPIRES_SECONDS - Time in seconds after which a session expires -- ETHERPAD_ETHERPAD_COOKIE_RELEASE_THRESHOLD - Time in seconds after which a session is not returned to the user +- ETHERPAD__COOKIE_EXPIRES_SECONDS - Time in seconds after which a session expires +- ETHERPAD__COOKIE_RELEASE_THRESHOLD - Time in seconds after which a session is not returned to the user -- ETHERPAD_API_KEY - Api key used for authentication of schulcloud server requests +- ETHERPAD__API_KEY - Api key used for authentication of schulcloud server requests -- ETHERPAD_URI - Uri of etherpad api for all calls like create, delete etc. Used as base path for api client in nest and feathers backend. +- ETHERPAD__URI - Uri of etherpad api for all calls like create, delete etc. Used as base path for api client in nest and feathers backend. - ETHERPAD__PAD_URI - URI to etherpad client api. Used in backend in collaborative text editor and lesson to build return url. Used in legacy client to build url. - ETHERPAD_OLD_PAD_URI - Used in feathers backend to restrict access to old etherpad urls to lesson context. Only defined in default.schema.json and not in dof-app-deploy