From 09be4d781545394fdbcce585b2e1da27e22888de Mon Sep 17 00:00:00 2001 From: Florian Scholdei Date: Thu, 20 Mar 2025 09:09:12 +0100 Subject: [PATCH] Remove obsolete documentation Squash commits of branch feature/doc_jwt: - Remove obsolete documentation --- docs/en/administration/jwt-configuration.md | 26 ------------------- .../ui-webapp/public/locales/en/config.json | 2 +- 2 files changed, 1 insertion(+), 27 deletions(-) delete mode 100644 docs/en/administration/jwt-configuration.md diff --git a/docs/en/administration/jwt-configuration.md b/docs/en/administration/jwt-configuration.md deleted file mode 100644 index 51add16688..0000000000 --- a/docs/en/administration/jwt-configuration.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: JWT Configuration ---- - -SCM-Manager uses [JWT](https://datatracker.ietf.org/doc/html/rfc7519) to authenticate its users. -The creation of JWTs can be controlled via Java system properties. - -## Endless JWT - -Usually a JWT contains the exp claim. This claim determines how long a JWT is valid by defining an expiration time. -If the JWT does not contain this claim, then the JWT is valid forever until the secret for the signature changes. -Per default the JWT created by the SCM-Manager contain the exp claim with a duration of one hour. - -If needed, it is possible to configure the SCM-Manager, so that the JWT get created without the exp claim. -Therefore, the user session would be endless. - -We advise **against** this behavior, because limited lifespans for JWT improve security. -But if you really need it, you can enable endless JWT by starting the SCM-Manager with this flag: - -``` --Dscm.endlessJwt="true" -``` - -If you want to disable the feature, then restart the SCM-Manager without this flag. -If you want to invalidate already created endless JWT, then restarting the SCM-Manager, with the endless JWT feature disabled, is enough. -The SCM-Manager will automatically create new secrets for the JWT and therefore invalidate every already existing JWT. diff --git a/scm-ui/ui-webapp/public/locales/en/config.json b/scm-ui/ui-webapp/public/locales/en/config.json index fa2b13651a..1a7af32ec6 100644 --- a/scm-ui/ui-webapp/public/locales/en/config.json +++ b/scm-ui/ui-webapp/public/locales/en/config.json @@ -28,7 +28,7 @@ "jwtSettings": { "subtitle": "JWT Settings", "label": "Expiration time", - "help": "Set the JWT expiration time in hours. If you want to set the time to endless consider the 'endlessJWT' option inside the 'config.yml'.", + "help": "Set the JWT expiration time in hours. If you want to set the time to endless consider the 'endlessJwt' option inside the 'config.yml'.", "hoursWarning": "It is not recommended to set the expiration time over 24 hours.", "endlessWarning": "The expiration time is set to endless." },