When you install Quill Extension on-premise, you will be (1) creating a Quill API service and (2) generating an extension file (.trex or .zip) that communicates with your Quill API service.
Please see Technical Architecture for diagrams on setting up Quill Extension with and without a load balancer.
Install the Quill API
- Extract the installation tarball provided by Narrative Science or one of its partners with this command:
tar -xf /path/to/installer.tar.gz
- One of the files in the archive is called config.yml.sample. This file is a sample configuration file. Copy this file and name it config.yml.
cp config.yml.sample config.yml
- When the installer is run, it will read the configuration file (config.yml) in order to create the Quill API and/or licensing agent. Before proceeding, open the file and edit it according to the instructions provided in that file. You will be using the values you collected from Step Installation Preparation.
- Ensure that the licensing agent is set to no, and that there is a brand new line reading license_type: unrestricted. This means the first 3 uncommented lines in your configuration file should read:
- Run the install command:
sudo ./inbi install
- Start the services with this command:
sudo ./inbi start
- Validate that the narrative generation service is running successfully by executing these commands:
curl https://localhost --insecure
sudo ./inbi status
You have now completed installation of the Quill API.
If you are installing the Quill API behind a load balancer, please complete the above steps for each machine behind your load balancer.
Generate the Tableau, Qlik, or PowerBI extension
Now that your local Quill API is running successfully, you can generate the extension that communicates specifically with this specific server (or cluster) within your network.
- Generate the extension artifact with this command:
sudo ./inbi create-extension
For Tableau installations:
This create-extension command above will create a .zip file. When you unzip the file, you will receive a .trex file which you can then upload into your individual Tableau Desktop workbook. You can then email that workbook to other Desktop 2018.2+ users, or push that workbook to Tableau Server (as long as your Server instance is also version 2018.2+).
For Qlik installations:
This create-extension command above will create a .zip file, which you will then upload into your Qlik Management Console (QMC). You can then control which Qlik users have access to the extension via the QMC's functionality.
For PowerBI installations:
This create-extension command above will create a .pbiviz file. You can then transfer that file onto your local machine and upload it into your PowerBI dashboard.