FINERACT-1758: Improve custom module example (fix)

2022-10-21 19:01:35 +02:00
parent 81d9e4a961
commit 0049a9e3f9
4 changed files with 10 additions and 27 deletions
@@ -63,6 +63,15 @@ If database migrations are needed as part of your customizations then you can ad
 include::{diagramsdir}/custom-db-migration-folder-structure.puml[]
 ----

+And here an example migration script:
+
+[source,xml]
+----
+include::{rootdir}/custom/acme/note/starter/src/main/resources/db/custom-changelog/0001_acme_note_initial.xml[lines=22..]
+----
+
+IMPORTANT: By default custom database migration changelogs are executed in context `tenant_db`. That makes sure your changes will be applied to the tenant database (read: main database and not the tenant store database). In theory you could also target the tenant configuration database, but it's not recommended to do that.
+
 === Deployment

 Custom modules (better: the JAR files) only need to be dropped in Fineract's `libs` folder if you run Fineract from the Spring Boot JAR file. Dynamic loading of external JARs is provided since Fineract version 1.5.0. For your convenience we've created a separate Docker image module that automatically includes your custom modules (see `custom/docker`). You can build this Docker image with