You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@fineract.apache.org by "edk12564 (via GitHub)" <gi...@apache.org> on 2026/08/21 04:04:06 UTC

[PR] Add docs for contributor onboarding [fineract-consumer-facing]

edk12564 opened a new pull request, #120:
URL: https://github.com/apache/fineract-consumer-facing/pull/120

   Issues: https://github.com/apache/fineract-consumer-facing/issues/118
   
   # Summary
   
   In order to onboard contributors quickly, we should add extensive documentation on the app and best practices. An adoc book for frontend and backend, along with asciidoctor was utilized to render the book on a webpage. 
   
   To render the docs, simply run:
   
   Backend for Frontend:
     ./gradlew :docs:asciidoctor
     open ../docs/build/docs/html/index.html
   
   Frontend:
     ./gradlew :docs:asciidoctorFrontend
     open ../docs/build/docs/html-frontend/index.html
   
   from /consumer.
   
   On top of adocs, plant UML was used for diagrams. 
   
   Finally, the README.md was updated to include instructions on how to render the docs, along with updated file structure.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@fineract.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Add docs for contributor onboarding [fineract-consumer-facing]

Posted by "Aman-Mittal (via GitHub)" <gi...@apache.org>.
Aman-Mittal commented on code in PR #120:
URL: https://github.com/apache/fineract-consumer-facing/pull/120#discussion_r3852064066


##########
docs/consumer/appendix/properties-openbanking.adoc:
##########
@@ -0,0 +1,33 @@
+= Open Banking Properties
+
+Settings for the in-process OAuth2 authorization server that issues consent-scoped tokens to third-party providers (TPPs), bound by `OAuth2ConsumerProperties` (`consumer.oauth2.*`). Approved TPPs are not configured here; they live in the `registered_tpps` database table, so onboarding and revocation never need a redeploy.
+
+.Open Banking Properties
+|===
+|Name |Env Variable |Default Value |Description
+
+|consumer.oauth2.access-token-ttl
+|OB_ACCESS_TOKEN_TTL
+|5m
+|Lifetime of an open-banking access token (deliberately shorter than the consumer session token).
+
+|consumer.oauth2.refresh-token-ttl
+|OB_REFRESH_TOKEN_TTL
+|90d
+|Lifetime of an open-banking refresh token held by a TPP.
+
+|consumer.oauth2.consent-ttl
+|OB_CONSENT_TTL
+|90d
+|How long a customer's data-sharing consent remains valid before the TPP must obtain a fresh one.
+
+|consumer.oauth2.frontend-base-url
+|OB_FRONTEND_BASE_URL
+|http://localhost:4443
+|Base URL of the Angular frontend, used to build the consent-approval redirect during the authorization flow.
+
+|consumer.oauth2.kid
+|OB_JWT_KID
+|bff-es256

Review Comment:
   Add Warning to immediately that to rotate token



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@fineract.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Add docs for contributor onboarding [fineract-consumer-facing]

Posted by "Aman-Mittal (via GitHub)" <gi...@apache.org>.
Aman-Mittal merged PR #120:
URL: https://github.com/apache/fineract-consumer-facing/pull/120


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@fineract.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org