Public | Automated Build

Last pushed: 4 months ago
Short Description
Sample php web application demonstrating the usage of the php library FatcaIdesPhp
Full Description

IDES-Data-Preparation-Php

This is a sample php web app that uses fatca-ides-php
php library to convert bank client data to FATCA files submittable via the IDES gateway.
Its dockerfile image is automatically built on docker hub here
(also mentioned in the Usage section below and in the Developer notes section)

For more information check the IRS FATCA IDES Technical FAQs

For other language implementations, please check the IRS github page

Pre-requisites

docker

Usage

You can use this image as a web app or as a CLI.

To use it as a web app:

  1. Run the dockerfile with docker run -p 8123:80 -d -t shadiakiki1986/ides-data-preparation-php
  2. Navigate in your browser to http://localhost:8123

To use it as a CLI

  1. Run the dockerfile with docker run -it --entrypoint bash shadiakiki1986/ides-data-preparation-php
  2. At the terminal inside the image run php www/transmitter.php --help

To load the workspace folders to the host, e.g. to see the downloaded files, or the backed up generated files:

  1. Create an empty directory /home/shadi/ides_cache
  2. Run image with docker run -p 8123:80 -d -v /home/shadi/ides_cache:/var/lib/IDES/cache -t shadiakiki1986/ides-data-preparation-php

To set your own institution GIIN, receiver GIIN, SSL certificate, private/public keys:

  1. Create an empty directory /home/shadi/ides_etc
  2. Run image with docker run -p 8123:80 -d -v /home/shadi/ides_etc:/var/lib/IDES/etc -t shadiakiki1986/ides-data-preparation-php
  3. Run docker stop -t shadiakiki1986/ides-data-preparation-php
  4. Edit the file /home/shadi/ides_etc/config.yml to set the GIINs (or copy to a config.override.yml file)
  5. Copy your certificate, private/pubic keys to /home/shadi/ides_etc/ssl, using the same filenames (otherwise change the desired names in the config.yml file)
  6. Re-run the image with the run step above

To set your own getFatcaData php function

  1. say it's at /home/shadi/ides_src/getFatcaData.php
  2. Run image with docker run -p 8123:80 -d -v /home/shadi/ides_src:/var/lib/IDES/src -t shadiakiki1986/ides-data-preparation-php
  3. Note that this only works for a simple php function that doesnt require further package installations

Security note

This demo app will show the field upload password in plain text in the URL after clicking on Get data

Emailing

The email smtp configuration is disabled in etc/config.yml for the automated build

License

Please check [[LICENSE]]

Developer notes

docker build .
docker run -i -p 80:80 -t CONTAINERID
docker run -i -p 80:80 -v /home/ubuntu/Development/IDES-Data-Preparation-Php/www:/var/lib/IDES/www -t CONTAINERID

docker build --no-cache .
docker run -i -p 80:80 --entrypoint bash -t CONTAINERID

When moving to php 7, I need to change

  • the php5-... package names in apt-get install
  • the php5/cli/php.ini paths
  • use pecl install yaml-beta instead of yaml
  • check if php5enmod or just phpenmod

To publish app in aws elasticbeanstalk

  • read this
  • for continuous deployment, couple the travis-ci after_build with elasticbeanstalk CLI
Docker Pull Command
Owner
shadiakiki1986

Comments (0)