Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ We recommend using the JAR instead of the WAR file deployment, because it's much
How to run using Docker or Podman
---

It is possible to do a 'one-touch' installation of Fineract using containers (AKA "Docker").
It is possible to do a 'one-touch' installation of Fineract using containers (AKA "Docker") for dev/test convenience and local/offline demos.
This includes the database running in the container.

As prerequisites, you must have `docker` and `docker-compose` installed on your machine; see
Expand All @@ -165,6 +165,9 @@ Alternatively, you can also use [Podman](https://github.com/containers/libpod)
(e.g. via `dnf install podman-docker`), and [Podman Compose](https://github.com/containers/podman-compose/)
(e.g. via `pip3 install podman-compose`) instead of Docker.

> [!CAUTION]
> Our images are NOT production-ready. For example, notice how the `test` Spring profile is enabled via `fineract-common.env`, included by `docker-compose.yml`, but `test` must not be enabled in production. YOU are responsible for securing your production instances. See [How to run for production](#how-to-run-for-production).

To run a new Fineract instance on Linux you can simply:
```bash
git clone https://github.com/apache/fineract.git
Expand Down
Loading