This repository has been archived on 2025-06-21. You can view files and clone it, but you cannot make any changes to it's state, such as pushing and creating new issues, pull requests or comments.
suitedesk/libraries/README.md

70 lines
2.5 KiB
Markdown

REQUIRED LIBRARIES
==================
This directory should be used to place downloaded libraries. This will allow you
to more easily update **SuiteDesk** core files. Download and install:
### PDF tools
**wkhtmltopdf support**
The print PDF module requires the use of an external PDF generation tool. The
currently supported is *wkhtmltopdf*. To install follow the next steps:
1. Download *wkhtmltopdf* from https://wkhtmltopdf.org/downloads.html/. You can
choose to download the source and compile it or simply download the static
binary, which doesn't require you to compile anything. Note that the compiled
version may require a running X server (static uses patched libs that can
work without one).
2. Place the `wkhtmltopdf` executable into the `libraries` directory. You can
also place a symbolic link to the executable.
3. Check https://wkhtmltopdf.org/usage/wkhtmltopdf.txt for further information.
**TCPDF support**
Used by the invoices module. This module requires TCPDF >= 6.2.000.
1. Download TCPDF from http://sourceforge.net/projects/tcpdf/.
2. Extract the contents of the downloaded package into the `libraries`
directory. There is no need to modify the `config/tcpdf_config.php` file, as
the module self-configures TCPDF.
3. Grant write access to the `cache` and `images` directories to your webserver
user.
4. Check http://tcpdf.sourceforge.net/ for further information.
### HTML Purifier library
Make sure you check *HTML Purifier* and make sure that you have fulfilled all of
its requirements before running this. Specifically, you'll need the PHP
extension `ctype` (in almost all PHP distributions), and it's nice to have `dom`
and `iconv`.
Download HTML Purifier from http://htmlpurifier.org/. You will need 4.8.0 or
later. Extract the `library` folder to `libraries` directory. The final setup
should be:
libraries/htmlpurifier/
HTMLPurifier
HTMLPurifier.autoload.php
HTMLPurifier.auto.php
HTMLPurifier.func.php
HTMLPurifier.includes.php
HTMLPurifier.kses.php
HTMLPurifier.path.php
HTMLPurifier.php
HTMLPurifier.safe-includes.php
### dhtmlxGantt library
Download dhtmlxGantt from https://dhtmlx.com/docs/products/dhtmlxGantt/. You
will need 3.2.0 or later. Extract the `codebase` folder and rename it to
`dhtmlxgantt` in the `libraries` directory. The final setup should be:
libraries/dhtmlxGantt/
connector
ext
locale
skins
sources
dhtmlxgantt.css
dhtmlxgantt.js