Thanks Adam for adding the context and explanations. I especially endorse the Production guide concept with the usual *caveat emptor. *
+1 On Wed, Oct 1, 2025 at 2:00 PM Adam Monsen <[email protected]> wrote: > +1, thanks Felix! > > I got to take a peek at Felix's work so far on the guide for running > Fineract in production. Looks great so far. We agreed there isn't a place > for this content in the Fineract README or official docs, but it might be > OK to include on the wiki (with appropriate disclaimers). I personally know > nothing about actual current Fineract deployment best practices (other than > my general sysadmin knowledge & experience). I also don't know what is > lacking and needed in terms of deployment documentation... personally I'd > be most interested in the fundamentals (resources & ports needed, > routes/links, security & compliance considerations) and I was able to > derive most of this from existing docs and tinkering. *Felix is looking > for collaborators on his guide*. > > Separately, Felix is working on improving the top-level Fineract README. > > I added my thoughts on this to FINERACT-2383 > <https://issues.apache.org/jira/browse/FINERACT-2383?focusedCommentId=18024135&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-18024135>, > including: > > --- ✂️ --- > > I believe the target audience of the README is and should be developers. > in general > > To review, we have these doc resources: > > 1. README > 2. wiki > 3. official docs > > I think the top-level README should be pared down to a terse and useful > "quick start" guide for devs. That's it. Anything else should be moved to > the wiki or official docs. If you agree, let's add a disclaimer to the top. > > The wiki (hosted by ASF, confluence, contains supplemental collaborative > documentation) is allowed to be a bit more messy and in flux, I'd say. It > makes sense the wiki would have a wider target audience (especially since > it's easier to edit/collab there). > > The official docs (asciidoc in source control under fineract-doc/), built > & published at https://fineract.apache.org/docs/current/) are where we > want to aim for high quality, illustrative, exhaustive content. > > Ideally all these doc changes are coordinated with code changes to > simplify test/build/run/demo operations, as well as the product roadmap > (wherever that is). > production > > I think it's a good idea to say something about running in production, > e.g.: > > Fineract is powerful, flexible, and secure. Running Fineract just to try > it out is relatively easy. This might take a few minutes to complete for a > developer who has done it before. If you intend to use it for customers, be > aware that a proper Fineract production deployment can be very complex, > costly, and time-consuming. Considerations include: Security, privacy, > compliance, performance, service availability, backups, and more. The > Fineract project does not provide a comprehensive guide for deploying > Fineract in production. You will need dedicated IT resources skilled in > enterprise Java applications. Or you can pay a vendor for Fineract > deployment and maintenance. Also, you will find tips and tricks for > deploying and securing Fineract in our official documentation > <https://fineract.apache.org/docs/current/>, and there are also > community-maintained > use cases on the wiki > <https://cwiki.apache.org/confluence/display/FINERACT/Hosting+Fineract>. > >
