Code Monkey home page Code Monkey logo

fiul's Introduction

⛽ FIUL

Pronounced: Fuel, फिऊल

The Financial Information User Layer (FIUL) is an open source java based implementation for the Account Aggregator FIUs designed with performance, security and privacy in mind.

Getting Started

Using Docker

Docker image for fiul is hosted on Github Packages. Refer following steps for get it running:

Prerequisite: Set up github authentication, refer this official documentation.

  1. To pull the latest dev image, run:
docker pull ghcr.io/finarkein/fiul:dev
  1. Configure your docker environment with required environment variables.
# Export environment variables to run the docker image
export SECRET_KEYSET=$(cat path_to_keypairset.json)
# Set clients credentials path w.r.t the container
export AA_API_CREDENTIALS=/etc/secret/aa_credentials.json
  1. Run the following command to start your FIU instance:
docker run -e AA_API_CREDENTIALS -e SECRET_KEYSET -p 7065:7065 -v local_path_to_aa_credentials.json:/etc/secret/aa_credentials.json --name fiul ghcr.io/finarkein/fiul:dev

Replace path_to_keypairset.json & local_path_to_aa_credentials.json to file paths available in your environment.

Configuration

Checkout the complete available configuration here.

Environment Variables

Variable Comment
SECRET_KEYSET JSON string of the JWK Pair Set provided to Sahamati Central Registry (CR). Reference json format.
AA_API_CREDENTIALS Path to AA client credentials json file. Reference file format. Optional if aa_credentials.json file is already present in classpath.

Getting Involved / Contributing

To contribute, simply make a pull request and add a brief description of your addition or change. For more details, check the contribution guidelines.

License

Refer to LICENSE for more details. Please note that this is a work in progress, and we're working to finalize the terms. Feel free to reach out to us using: oss (at) finarkein (dot) com, to discuss further.

fiul's People

Contributors

dependabot[bot] avatar dheerajkhardwal avatar primarypi avatar rangya avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.