Setup Instructions PivotData Microservice Documentation


PivotData microservice is a .NET Core application that can be installed on the following platforms:

  • Windows: 2008 R2 - 2016 Server, Win7 SP1, Win8, Win10
  • Linux: Ubuntu (14.04, 16.04), Debian, RedHat, Mint, Centos, Oracle Linux (and other supported by .NET Core)
  • Mac OS X

Prerequisites

  1. Install .NET Core 2 runtime
  2. Dependencies:
    • PDF export: no actions required (wkhtmltopdf binaries are shipped with PivotData microservice)
    • PDF export: install wkhtmltopdf version 0.12.4.
      For Ubuntu Server 16.04:
      $ sudo apt-get update
      $ sudo apt-get install libxrender1 fontconfig xvfb
      $ wget https://downloads.wkhtmltopdf.org/0.12/0.12.4/wkhtmltox-0.12.4_linux-generic-amd64.tar.xz -P /opt/
      $ cd /opt
      $ sudo tar xf wkhtmltox-0.12.4_linux-generic-amd64.tar.xz
      $ sudo cp /opt/wkhtmltox/bin/wkhtmltopdf /usr/bin/wkhtmltopdf
      For Ubuntu 14.04 last command should be:
      sudo ln -s /opt/wkhtmltox/bin/wkhtmltopdf /usr/local/bin/wkhtmltopdf
    • ODBC connector (only if you use it): install unixODBC (version 2.3.1 or higher).
      For Ubuntu Server 16.04:
      sudo apt-get update
      sudo apt-get install unixodbc
      Then, install ODBC driver(s) you need. Don't forget to register driver in odbcinst.ini and DSN in odbc.ini (if you use DSN). For more details, see setup instructions provided by driver's vendor.

Start a microservice

For testing purposes it is enough to extract PivotData microservice binaries to some folder and start it from the command line:

dotnet NReco.PivotData.Service.dll

This will start microservice web application with default binding for localhost:5000 by default (not accessible by external IP). You can change binding by specifying additional option:

dotnet NReco.PivotData.Service.dll --server.urls=http://0:0:0:0:5000

In production environment it should be deployed as any other .NET Core app - only difference that you already have complied 'published' binaries for framework-dependent deployment. More details about concrete deployment scenarious:

Running in a Docker container

PivotData microservice can be Dockerized as any other .NET Core application; standard how-tos on this topic are fully applicable:

Only notice that you don't need to compile and publish .NET Core app ('dotnet publish') because you already have "published" microservice binaries.


Next step: configure appsettings.json