You are currently offline, serving cached version

Commercial FAQ

Can I get a free trial ?

  1. If you're not sure if our product is right for you, we offer a two-week 100% money-back guarantee.
  2. We also have a live demo site with all modules enabled, so you can test out for example the HTML module and also upload your own templates.
  3. If you need more information, we can arrange a free video call to help you find out what you need. Click here to book the call.

What is the LICENSE ?

You can download the license file for docxtemplater PRO, docxtemplater ENTREPRISE or a single docxtemplater Module here.

How do I get the modules ?

Right after your payment (within 5 minutes), you should receive an email with urls that allow you to do

npm install --save <secret-url>

Each of the version of each modules has a unique URL, so that you can point to one specific version so that nothing will break if you did not intend to upgrade.

Can I get a Promotional Code / Discount ?

I do not offer discount codes. The price is the same for everyone.

Can I still use the software next year if I stop paying ?

No. The docxtemplater PRO plan / ENTREPRISE plan / SINGLE MODULE plan / are for a duration of 1 running year at the time of the payment (from 16th August 2017 to 16th August 2018 for example). It allows to run the software in production for that period of time, and gives you access to all updates and support.

It costs 1250 euros for one year. It cannot be canceled during the year, only after the end of the period.

If you stop using the modules, you don't have to pay anymore.

Whenever you subscribe to docxtemplater pro, you will get a unique URL that allows you to do npm install <secret-url> to install each of the modules. If after one year, you do not renew, the url expires and you won't have access to the package anymore.

Here are a few examples of what is possible :

  • Company Acme buys the PRO module on 16th August 2017 and pays 1250 euros. After one year, they decide they don't need the module anymore, and the URL expires on 16th August 2018.

  • Company Acme buys the PRO module on 16th August 2017 and pays 1250 euros. After 9 months they do not need to use the modules anymore. They don't get money back, the subscriptions are for one year.

  • Company Acme buys the PRO module on 16th August 2017 and pays 1250 euros. After one year, they wish to continue using the modules, and pay the renewal at 1250 euros per year.

Can I use the license for SaaS ?

Yes, the license model is suitable for Software as a Service businesses. As long as you are the entity running docxtemplater software, you can use the normal licenses.

You are however not allowed to install the PRO/ENTREPRISE or docxtemplater modules software on-site on your clients servers.

After I bought the modules, can I get some technical support ?

Yes, if you have any issues with docxtemplater (open-source) or one of the modules, I will give you support without additional charges.

To have faster answers, please include the used modules, the template document, your JSON data, and code.

Can I resell your software ?

Resellers can buy docxtemplater modules, the PRO,ENTREPRISE, or PREMIUM docxtemplater version on behalf of their customers. They must provide a distinct email address for each customer and be able to pay via credit card or invoice with no manual process on our part. We will not allow resellers who require annual handholding or manual processing.

As a reseller, you use a different email for each customer of yours, and you are allowed to transfer the access links to your customers. Please then send us an email to tell us who the customer is so that we know whom we should provide support to.

We do not offer discount to resellers.

Can I redistribute docxtemplater-pro or entreprise to my customers ?

This is a common requirement for the "appliance" model, where you install you sell software to other companies. The standard license does not allow to redistribute the software.

The Appliance license plan costs :

  • 6000€ per year for the PRO feature set (choose 4 modules)
  • 12000€ per year for the ENTREPRISE feature set version
  • 2500€ per year for a single module license.

All Appliance licenses also get priority email support, with average response time of 24 hours.

It allows you to distribute the modules contained in the PRO or ENTREPRISE module as part of your application. You are not allowed to resell the modules as is.

This method of distribution is also sometimes called on premise.

Is it possible to upgrade from the PRO plan to the ENTREPRISE plan ?

Yes, that is possible, we make the upgrade easy and you won't have to pay twice.

Similarly, it is possible to upgrade from a single module to a plan that contains that module (from single image-module to PRO for example). It is however not possible to switch from one module to the other.

To upgrade, simply pay for the PRO, ENTREPRISE, or PREMIUM Plan and then ask me a partial refund for the modules that are part of then newly upgraded plan.

Let's take an example to make things clear.

The Acme Company buys the PRO Plan on September 1st 2023 for 1250€ for one year. On December 1st they wish to use the ENTREPRISE module which costs 3000€. In that case, the plan expiration date is extended to finish on December 1st of 2024, and the company will have a credit balance for all the "unused" days, eg the number of days between December 1st 2023 and September 1st 2024. In our example, that would be 273 unused days out of 365, which is about 75%, so the credit will be of 938€ (75% * 1250€). Thus the payment for the upgrade would be of 2062€ instead of 3000€ in that case.

What exactly is a Worker when using docxtemplater server-side ?

In the license terms, it is specified that you cannot exceed the maximum number of Workers authorized at the time of purchase. The ENTREPRISE and PRO plan, as well as the single module plans, each include a limit of max 5 Workers (except if specified otherwise in your invoice).

By the word "Worker", we mean the number of CPUs that are running docxtemplater-pro or docxtemplater-entreprise software. For example, if you use 4 servers in production that have the pro software installed, and they run the software on only one CPU each (if you run the software on multiple processes for each server, each process counts as one Worker), the quota of used workers will be of 4 out of 5 which is the maximum limit for that license.

Development and testing instances do not count, you can use as many workers as you need on non-production instances.

If you need more than 5 Workers, please contact us (email is in the footer).

What exactly is a Worker when using docxtemplater client-side ?

When you use docxtemplater client side, Workers are not the number of CPUs, but each user (real life person) that has access to docx generation in your application is counted as 0.005 Worker, which means if you buy the PRO license giving you a limit of 5 Workers, you are allowed to have a maximum of 1000 users with access to the features given by docxtemplater Modules.

Development and testing instances do not count, you can use as many workers as you need on non-production instances.

How to count Workers on serverless instances

When using serverless providers (such as AWS Lambda), the worker count is different than when running docxtemplater on a traditional server.

In that case, you are allowed to call the docxtemplater rendering engine up to 50 times the number of Workers you have per hour.

For example, if your license gives you 5 workers, you can run the given lambda up to 250 times per hour. ie run 250 lambdas per hour that will use the docxtemplater modules that you've purchased.

Can I buy a perpetual license of docxtemplater ?

Yes, there is an option to buy a perpetual license, which allows you to install the software on new hosts perpetually.

The pricing for the Entreprise feature set for this model is 12250€ one time. We will in this case also give you support for a duration of 3 years.

The max worker count of 5 Workers still applies.

Can you send me a quote or an invoice ?

Yes, you can get a quote for the entreprise license (at 3000€/year) :

You will then have to send approval via a PO or simple email.

Can I pay for the software by wire transfer ?

We accept payment by wire transfer only if you buy the docxtemplater ENTREPRISE Plan (at 3000€ per year) or if the amount is higher than 1500€ per year.

We accept IBAN (European bank transfers), and if you want to do a bank transfer from outside the EU, you will have to pay any additional fees.

To request a quote for the ENTREPRISE Plan, use following page.

Can I pay monthly or quarterly instead of yearly ?

The docxtemplater modules are bought on a yearly basis, no exceptions.

What support do you offer ?

For the support, it includes a response usually in less than a business day to each question regarding :

  • the usage of a module that you've access to
  • the usage of the main docxtemplater library
  • fixing bugs where a template results in an error that is not correctly handled by the library
  • providing help to achieve one of your goal in generating documents
  • fixing performance issues
  • adding small features (that are done on my side in less than 4 hours), that make sense in generalfor other users of docxtemplater or of the paid modules

It does not include development of new features that take over 4 hours of work, or that are not generic enough to be used by other users of docxtemplater.

Canceling the subscription

You can cancel the subscription at any time by simply sending an email to us (see Contact us button at the bottom of this page).

After cancelation, your credit card will no more be charged, and after your subscription period ends, you will no more be allowed to install the docxtemplater modules on any new servers. You will also get access to all updates and support.

Requesting a refund

During the two weeks following your purchase, you are allowed to ask for a 100% refund. In that case, you will no longer be allowed to use the software.

To request a refund, send us an email with your account information.

Legal Information

The legal information for the company publishing docxtemplater.com and its modules is :

  • Company Name: Coding Puffin SAS
  • VAT NUMBER: FR60890806888
  • SIRET Number: 89080688800016
  • Company Address: 6 rue Jean Zay, 91300 Massy, France

If you need a contact email, for all purposes (marketing, legal, tech support, …), please use the email shown when you click "contact us" at the bottom of the page.

My bank information details can be found on the invoices that I will be sending you.

Technical FAQ

Technical specification

Programming Language and Framework: JavaScript, no framework is used

Database Technology: The application is a software library and not a web application. Therefore, no database is required for the operation of the application. Data is provided to the library in the form of JSON.

Architecture Pattern: As it is a software library, the architecture consists of multiple npm packages (one package per module). Technically, docxtemplater provides an open-source core engine, and docxtemplater modules can be attached to a docxtemplater instance to provide additional functionnality.

Middleware and Integrations: No middleware components or API gateways are used.

Purpose and Objectives: The software library enables the creation of documents with Word, PowerPoint, or Excel templates and data.

Functions and Features: Generation of Word and PowerPoint documents with the open-source version, Excel documents with the Excel module. Ability to dynamically create images with the Image module

User Target Audience: Developers can install and configure the library. Normal Word/PowerPoint/Excel users that know how to use the Microsoft Office suite can create templates.

Platform and Compatibility: NodeJS version 18, 20, Browser (Chrome, Firefox, Safari, Edge). It runs correctly on Linux, Windows, Mac

User Interface: Technically, docxtemplater has no user interface, and needs to be integrated into an existing application.

Integrations and Interfaces: Integration is done with code, specifically with JavaScript.

Security: The software library does not access "external" services, meaning: No network requests and no file system calls are made by the library itself; these requests are made by the user of the software library.

Performance and Scalability: The library has been tested with extensive documents. Docxtemplater is quite fast. For a fairly complex 50-page document, it can generate 250 outputs of those documents in 44 seconds, which is about 180 ms per document.

Updates: A single command can update the modules: npm install docxtemplater && npx -y update-docxtemplater && npm install

Maintenance: Maintenance is provided as part of the product. Contact us with any bugs and we will try to fix them in a timely manner.

Documentation: The documentation for each module can be found here

Licensing and Costs: See pricing information / See license information

Support and Contact Options: Support is efficient: with the PRO version, the average response time is 48 hours, and with Enterprise, it is 24 hours. Via email, click on "Contact Us" at the bottom right of the screen to send us an email

References and Success Stories: See front page here

Future Development Plans: In the next few months, an API version of docxtemplater.

How can I run docxtemplater paid software ?

docxtemplater core and all docxtemplater paid modules are all written using javascript in a way that they can run both :

  • on a server using Node.js
  • in browsers

How do I get started with a module ?

After you have bought a license, you will get an email with commands to install each module you have access to.

How are the modules packaged ?

The modules are installed via npm, you'll have to run :

npm install --save <secret-url>

where secret-url is a url that will be unique for your account.

The files required to run in the browser are also bundled inside the package.

How can I use a module in the browser ?

All modules can be used in the browser (for example, it is possible for the image module, slides module, html module, …), you can use the file present in the build directory of your module. That is for example, in the case of the html module :

node_modules/docxtemplater-html-module/build/html-module.min.js

How can I know when new releases come out ?

All modules have a RSS Feed available at this link :

https://docxtemplater.com/modules/<module>/releases.rss

For example :

How are the modules tested ?

All modules are tested with integration tests (using real docx, pptx or xlsx documents), and cannot be published without the tests passing. The tests can be run by running npm test.

Where is the issue tracker ?

Here is the public github issue tracker.

It is also possible to contact us via email (on the bottom of this page), for questions with undisclosable files, or questions about sales.

Is it possible to generate a Table of Contents ?

This is a limitation of a templating engine. docxtemplater is not a rendering engine. Having a proper docx rendering engine running in NodeJS would require an enormous amount of work (basically the same amount of work that went to Microsoft Word). Since docxtemplater does not know how to render a docx document, (which determines the page numbers), this is why it is impossible to regenerate the page numbers within docxtemplater. A solution would be to look for a tool or script that can communicate with Word and regenerate the Table of Contents.

How can I update my modules ?

As long as you have an active subscription, you can download all latest docxtemplater modules.

You can upgrade your package.json automatically to upgrade all modules you are using and docxtemplater itself by using following command :

npm install docxtemplater && npx -y update-docxtemplater && npm install

How can I retrieve the docx content as text ?

You can use the following code sample, that doesn't use docxtemplater directly.

const PizZip = require("pizzip");
const { DOMParser } = require("@xmldom/xmldom");
const fs = require("fs");
const path = require("path");

function str2xml(str) {
    if (str.charCodeAt(0) === 65279) {
        // BOM sequence
        str = str.substr(1);
    }
    return new DOMParser().parseFromString(str, "text/xml");
}

function getParagraphs(content) {
    const zip = new PizZip(content);
    const xml = str2xml(zip.files["word/document.xml"].asText());
    const paragraphsXml = xml.getElementsByTagName("w:p");
    const paragraphs = [];

    for (let i = 0, len = paragraphsXml.length; i < len; i++) {
        let fullText = "";
        const textsXml =
            paragraphsXml[i].getElementsByTagName("w:t");
        for (let j = 0, len2 = textsXml.length; j < len2; j++) {
            const textXml = textsXml[j];
            if (textXml.childNodes) {
                fullText += textXml.childNodes[0].nodeValue;
            }
        }

        paragraphs.push(fullText);
    }
    return paragraphs;
}

// Load the docx file as binary content
const content = fs.readFileSync(
    path.resolve(__dirname, "examples/cond-image.docx"),
    "binary"
);

// Will print ['Hello John', 'how are you ?'] if the document has two paragraphs.
console.log(getParagraphs(content));

Skip templating of docProps/core.xml, docProps/custom.xml or docProps/app.xml

If your docx document contains some tags inside docProps/core.xml or docProps/custom.xml or docProps/app.xml, it is possible that the templating fails if there are some characters such as "{" or "}" in the contents of those files.

It is possible to not do any templating on those files using following code :

const avoidRenderingCoreXMLModule = {
    name: "avoidRenderingCoreXMLModule",
    getFileType({ doc }) {
        doc.targets = doc.targets.filter(function (file) {
            if (
                file === "docProps/core.xml" ||
                file === "docProps/app.xml" ||
                file === "docProps/custom.xml"
            ) {
                return false;
            }
            return true;
        });
    },
};
const doc = new Docxtemplater(zip, {
    modules: [avoidRenderingCoreXMLModule],
    paragraphLoop: true,
    linebreaks: true,
});
doc.render();

Common Errors

Error 'The scope parser for the tag "%image" failed to compile'

If you have the error :

The scope parser for the tag "%image" failed to compile

It means that you didn't attach the docxtemplater-image module.

To do this, you need to have following line ;

const doc = new Docxtemplater(zip, {
    modules: [new ImageModule(imageOpts)],
    // other options such as parser, delimiters, paragraphLoop, ...
})

See the image module docs for the full documentation about how to use the image-module.

Empty pages generated

Pages generated before or after a table

If your template is the following :

Table loop
Docx template with table loop

With following data :

doc.render({
    users: [
        { name: "John", age: 25, hobby: "Skiing" },
        { name: "Mary", age: 35, hobby: "Reading" },
        { name: "Jack", age: 35, hobby: "Reading" },
        { name: "Jack", age: 35, hobby: "Reading" },
        { name: "Jack", age: 35, hobby: "Reading" },
        { name: "Jack", age: 35, hobby: "Reading" },
        { name: "Jack", age: 35, hobby: "Reading" },
        { name: "Jack", age: 35, hobby: "Reading" },
    ],
});

It is possible that your template will create an unwanted empty page before the table or after the table, like this :

Rendered table with two empty pages
Result document with one pagebreak before and after

There are several things that you can check on the table to fix this.

  1. Many times, there is a tag called <w:keepNext> that is set on the table.

    When this tag is specified on a given paragraph, it means that it should be rendered on the same page as the next paragraph when possible. If multiple paragraphs are to be kept together but they exceed a page, then the set of paragraphs begin on a new page and page breaks are used thereafter as needed.

    Reference: ECMA-376, 3rd Edition (June, 2011), Fundamentals and Markup Language Reference § 17.3.1.15.

    It is possible to fix this issue by changing the paragraph properties and unchecking "Keep with next", like this :

    Screenshot of Word showing the paragraph properties
    Paragraph properties to change

  2. Also, you have to check paragraphs preceding the table, if there are some empty paragraphs and you don't need them, you can remove them.

  3. To remove the pagebreak that comes right after the table, there is another trick :

    Each table in word requires to have a paragraph right after the table. This means that even if the table fits into the page, the paragraph that comes right after the table will sometimes force the page to break.

    To fix this, I recommend you to change the fontsize of the paragraph that comes right after the table to a font-size of "1".

Last page empty when using a loop that contains a page or section break

If you include a pagebreak inside a loop, you will get an empty page at the end of your document.

For example, in this document :

template with loop containing section break
Template with {#loop} containing section break

In this case, the last page in the generated document will be an empty page.

It is possible to use the "dropLastPageIfEmpty()" method from the meta module to fix this issue.

Is it possible to include an Excel document into a Word document ?

At the current time, it is not possible to include an excel document into a Word document.

The reason for this is that in the OpenXML Specification, (the specification of the docx/pptx/xlsx formats), when you embed an Excel file in a Word file, Word will store a preview of the excel document that it will show on the Word interface. This preview is an image that is taken by Microsoft Word itself. If this image preview is not present in the file, it will not show the excel file correctly. To generate this image preview, docxtemplater would have to have a rendering engine that can convert an XLSX file into an image file, which is currently not possible because creating a rendering engine that handles all cases would be quite difficult.

Corrupted zip : can't find end of central directory

This error message comes from the PizZip library, not from docxtemplater itself.

If you see this issue when you generate a document, it can mean multiple things :

  1. The document could be password-protected.

  2. The document could be a non-zip file (because all docx/pptx/xlsx files are actually zip files). In the browser environment, this typically happens when the response to your zip contains something else than a zip file (quite often, the contents of a 404 in HTML).

You can run the following code to see what the mime type and the buffer length of your file is :

const fs = require("fs");
const Docxtemplater = require("docxtemplater");
const PizZip = require("pizzip");
const magic = require("file-type-checker");

const buf = fs.readFileSync("examples/tag-image.pptx");

function logSignature(buf) {
    const type = magic.detectFile(buf);
    console.log("buffer length", buf.length);
    console.log("mime type is : ", type);
}
logSignature(buf);

const zip = new PizZip(buf);
const doc = new Docxtemplater(zip, {
    paragraphLoop: true,
    linebreaks: true,
});
doc.render(data);
Talk with sales Contact us