helidon icon indicating copy to clipboard operation
helidon copied to clipboard

Documentation bug in Security Providers

Open AshwinPrabhuB opened this issue 2 years ago • 1 comments

Environment Details

  • Helidon Version: 2.5.x
  • Helidon SE or Helidon MP: MP
  • JDK version: 17
  • OS: OS X

Problem Description

The MP security provider documentation uses clear text passwords in configuration. This however fails if I copy and paste the configuration into the quickstart project it fails with an obscure error ".. is a clear text password, yet encryption is required".

The example requires config.require-encryption=false, which is an undocumented configuration in Helido.io/docs, so the security providers example needs to mention this fact upfront to avoid having to google around for the failure text.

Steps to reproduce

[//]: # Follow along the tutorial: https://helidon.io/docs/v2/#/mp/security/02_providers

AshwinPrabhuB avatar Aug 30 '22 07:08 AshwinPrabhuB

The docs need to match what is actually in the aplication.yaml of IDCS example app on github

https://github.com/helidon-io/helidon/blob/db3fda88ee0e33f6ea56eca03c9b96e830732046/examples/security/idcs-login/src/main/resources/application.yaml#L21

Refer line 21

AshwinPrabhuB avatar Sep 21 '22 12:09 AshwinPrabhuB

Thanks for addressing this in the docs.

AshwinPrabhuB avatar Nov 15 '22 12:11 AshwinPrabhuB