Installation Steps


When you install Quill Extension on-premise, you will be creating (1) a Quill API and (2) a .trex file.

Please see Appendix A for diagrams on setting up Quill Extension with and without a load balancer.

  • If you are not using a load balancer, you will install the Quill API and licensing agent on the same server.
  • If you are using a load balancer, you will install the Quill API on multiple servers and you will install the licensing agent on a single server.


Install the Quill API

        1. Extract the installation tarball provided by Narrative Science or one of its partners with this command:


  • tar -xf /path/to/installer.tar.gz


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


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

See Appendix B for an example of how to fill out your config.yml for a single-node installation.


  • Run the install command:
  • sudo ./inbi install


          1. Start the services with this command:


  • sudo ./inbi start


          1. Validate that the narrative generation service is running successfully by executing these commands:


  • 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 every machine behind your load balancer.

Generate the Tableau extension

Now that your local Quill API is running successfully, you can generate the extension that communicates specifically with this local service.


    1. Generate the .trex extension with this command:


  • sudo ./inbi create-extension



This 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+).


If you are installing the narrative generation application behind a load balancer, you only need to generate the Tableau extension once. The same .trex file will be used for all Tableau users you’ve purchased licenses for.

Was this article helpful?
0 out of 0 found this helpful