libeufin

Integration and sandbox testing for FinTech APIs and data formats
Log | Files | Refs | Submodules | README | LICENSE

README (2223B)


      1 Installing LibEuFin
      2 ===================
      3 
      4 Although different versions of Java may support this project,
      5 the following steps were verified with Java 17.0.6.
      6 
      7 The following dependencies (names match Debian packages) should
      8 be available before trying the installation:
      9 
     10 - make
     11 - python3-venv
     12 - openjdk-17-jre-headless
     13 
     14 Run the following steps to install LibEuFin:
     15 
     16 $ ./bootstrap
     17 $ ./configure --prefix=$PFX
     18 $ make install
     19 
     20 If the previous step succeeded, libeufin-nexus and a command line
     21 client (libeufin-cli) should be found under $PFX/bin.  Additionally,
     22 the libeufin-bank command used for testing should be found under
     23 $PFX/bin as well.
     24 
     25 Running tests
     26 =============
     27 
     28 Tests need a PostgreSQL database called "libeufincheck".
     29 If the database setup is correct and LibEuFin is installed,
     30 the following command runs all the test cases:
     31 
     32   $ make check
     33 
     34 Launching LibEuFin
     35 ==================
     36 
     37 Launch Nexus:
     38 
     39 $ libeufin-nexus serve --with-db=jdbc:postgres://localhost:5433/$DB_NAME?user=foo&password=bar
     40 
     41 More instructions about configuring and setting Libeufin
     42 are available at this link:
     43 
     44 https://docs.taler.net/libeufin/nexus-tutorial.html
     45 
     46 Exporting a dist-file
     47 =====================
     48 
     49 $ ./bootstrap
     50 $ make dist
     51 
     52 The TGZ file should be found at: build/distributions/libeufin-$VERSION-sources.tar.gz
     53 
     54 Exporting an archive with the three executables
     55 ===============================================
     56 
     57 Such archive contains the compiled Bank and Nexus,
     58 and the CLI script.
     59 
     60 $ ./bootstrap # Needed to silence 'GNU make'
     61 $ make exec-arch
     62 
     63 Alternatively, the same archive is produced by:
     64 
     65 $ ./gradlew execArch
     66 
     67 The archive should be found at: build/distributions/libeufin-$VERSION.zip
     68 
     69 After extracting the compressed files, run the three
     70 executable found under the "bin/" folder.
     71 
     72 User interface
     73 ==============
     74 
     75 This repository does not ship any UI, rather it downloads
     76 one from the following project along the "make deb" target:
     77 https://git.taler.net/wallet-core.git/tree/packages/bank-ui
     78 
     79 This way, the libeufin-bank Debian package provides one
     80 self-contained solution including Nginx, LibEuFin Bank,
     81 and the UI.
     82 
     83 Note: the UI an independent Web app that could even be served
     84 from a different host than the one running the backend.