FAQ

This translation is out of date: the French version has changed since. View the French version

FAQ

The PDF is not generated, what should I do?

Check the following points:

  1. The DoliPDF module is enabled in the list of modules
  2. You use a document template in ODT format (DoliPDF does not work with the native PDF templates of Dolibarr)
  3. In remote mode: the server address, the email and the API key are correctly filled in
  4. In local mode: the LibreOffice command is correct and LibreOffice is installed on the server
  5. If the Run DoliPDF only on validated documents option is enabled, check that the document has the "Validated" status

I get the error "Error transferring PDF file"

This error means the PDF file was received from the DoliPDF server but the MD5 integrity check failed. The file may have been altered during the transfer. Try to generate the document again. If the error persists, check the network connection between your Dolibarr server and the DoliPDF server.

I get the error "DoliPDF error"

This generic error means the DoliPDF server could not perform the conversion. Possible causes are:

  • Invalid or expired API key
  • DoliPDF server temporarily unavailable
  • Corrupted ODT file, or in an unsupported format
  • Wrong DoliPDF server address

Look at the Dolibarr logs (dolibarr.log file) for more details on the error.

To find the cause, use the Test connection button of the Configuration tab: it checks the server address and the API key without converting any document, and shows a message naming the problem.

How do I get my API key?

If you do not have an account yet, open it from the Open an account tab of the module setup: the key is stored automatically as soon as your order is paid (see the configuration).

If you already have an account:

  1. Go to the DoliPDF server (by default https://pdf.cap-rel.fr)
  2. Log in with your account
  3. Open the API tokens menu
  4. Click New
  5. Copy the generated key into the configuration of the module

The conversion is refused: "no active plan"

The DoliPDF server only converts documents for an account whose plan is paid, and within the number of documents of that plan. The error message contains an Order a plan link that opens the order page.

Can I use my own DoliPDF server?

Yes. Enter the address of your server in the Dolipdf server address field of the setup. Your server must expose an API compatible with the DoliPDF protocol. Since version 1.0.18, the module calls the /api/v1/pdf (conversion) and /api/v1/ping (connection test) addresses: check that your server exposes them before updating.

The local mode does not work

Check that:

  • The Use LibreOffice installed locally option is enabled
  • The command given in Local command is correct and can be run by the web server user (for example www-data)
  • LibreOffice is installed on the server and available from the command line
  • The web server user can write in the destination directory of the PDF files

The PDF is regenerated on every line change

By default Dolibarr regenerates the document each time a product line is added or changed, which starts a DoliPDF conversion. To avoid this, enable the Disable PDF file creation each time a product line is added or modified option in the configuration of the module.

Does DoliPDF work with the native PDF documents of Dolibarr?

No. DoliPDF only converts ODT files to PDF. If you use the native PDF templates of Dolibarr (such as crabe, sponge, etc.), Dolibarr generates the PDF directly without going through DoliPDF.

Which Dolibarr versions are supported?

DoliPDF is compatible with Dolibarr 14 and later (checked up to Dolibarr 24), with PHP 7.4 minimum. The module includes a compatibility layer for versions older than Dolibarr 16.0 (FormSetup class).

FAQ Preguntas frecuentes