Syfooppdfgen

Repository for templates for generating PDF's from Oppfolgingsplaner.

Technologies & Tools

• pdfgen

Creating a docker image

Creating a docker image should be as simple as docker build -t syfopdfgen .

Getting started

Run in development mode

To run the application with templates, data and fonts locally mounted you can use

docker run \
        -v /full/path/to/templates:/app/templates \
        -v /full/path/to/fonts:/app/fonts \
        -v /full/path/to/data:/app/data \
        -v /full/path/to/resources:/app/resources \
        -p 8080:8080 \
        -e DISABLE_PDF_GET=false \
        -it \
        --rm \
        navikt/pdfgen

Or you can use the convenience script ./run_development.sh or ./run_development_windows.sh

When running the application you can use the env var DISABLE_PDF_GET to enable GET requests at /api/v1/genpdf/<application>/<template> which looks for test data at data/<application>/<template>.json and outputs a PDF to your browser. Additionally, the template folder will be fetched on every request, and reflect any changes made since the last GET, making this ideal for developing new templates for your application.

The template and data directory structure both follow the <application>/<template> structure. Example url:

http://localhost:8080/api/v1/genpdf/opservice/oppfolgingsplanlps
http://localhost:8080/api/v1/genpdf/oppfolging/mer_veiledning_for_digitale
http://localhost:8080/api/v1/genpdf/oppfolging/mer_veiledning_for_reserverte
http://localhost:8080/api/v1/genpdf/oppfolging/oppfolgingsplanlps
http://localhost:8080/api/v1/genpdf/oppfolgingsplan/oppfolgingsplan_v1

Run in development mode windows

For running on windows: ./run_development_windows.sh

Run in development mode using docker-compose

docker-compose -f docker-compose.yml up -d

Stop them all again

docker-compose -f docker-compose.yml down

The service is exposed on port 9001 when running through docker-compose

Notes on developing templates on Windows

It is a known issue that pdfgen's output documents look different depending on whether the template has \r\n or \n as line endings. Therefore, it is strongly recommended to configure Git to not convert newlines, as well as ensure that your editor ends its lines with LF (\n) and not CRLF (\r\n), as the former will accurately show what your templates will look like in production.

For NAV employees

We are available at the Slack channel #esyfo