⛽ 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

2. 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

3. 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.