> For the complete documentation index, see [llms.txt](https://docs.viesus.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.viesus.com/get-started/quickstart-pdf-enhancer.md).

# Quickstart: PDF Enhancement

Enhance your first PDF on-premise using the VIESUS PDF Enhancer. This guide takes you from installation to enhanced output.

**Prerequisites:** Access to the [VIESUS Transfer Portal](https://transfer.viesus.com) with a valid [license](/licensing/overview.md)

***

{% stepper %}
{% step %}

## Install the PDF Enhancer

Download from [transfer.viesus.com](https://transfer.viesus.com) and install. On Windows the VIESUS base package must be installed first; the Linux PDF Enhancer package bundles its own dependencies.

{% tabs %}
{% tab title="Linux (amd64)" %}

```bash
sudo dpkg -i viesuspdf_<PDF_VERSION>_amd64.deb
sudo apt-get install -f

# Verify
/usr/local/viesuspdf/bin/viesuspdf -v
```

{% endtab %}

{% tab title="Windows" %}
{% stepper %}
{% step %}
Install `VIESUS_Viewer_and_CLI_Setup_VIESUS_<VERSION>_GPU_x64.exe` (base package) first if not already installed.
{% endstep %}

{% step %}
Install `VIESUS_PDFEnhancer_<PDF_VERSION>_VIESUS_<VERSION>.exe` (right-click → **Run as administrator**, accept EULA, complete wizard).
{% endstep %}
{% endstepper %}

```powershell
"C:\Program Files\Imaging Solutions\VIESUS\PDFEnhancer\viesusPDF.exe" -v
```

{% endtab %}
{% endtabs %}

Expected output: `viesusPDF X.XX.XX 64 bit ...` (version matches the package you installed)

{% hint style="info" %}
For the full PDF Enhancer install walkthrough see [Installation](/installation/pdf.md).
{% endhint %}
{% endstep %}

{% step %}

## Activate your license

After installing, activate your license on the target machine.

* **GUID:** Add your GUID to the PDF Enhancer `settings.json` file. On Windows: `C:\Program Files\Imaging Solutions\VIESUS\PDFEnhancer\settings.json`. On Linux: `/usr/local/viesuspdf/settings.json`.

  ```json
  {
    "guid": "4e8f35ab-7f72-4b1e-a1fd-2b5e9c58e9d3"
  }
  ```
* **Activation Key:** Generate a request file with the VIESUS License Tool, send it to Viesus AG, and apply the activation file you receive back. Step-by-step with screenshots: [Licensing → Activation Key](/licensing/activation-key.md).

No license yet? Contact <info@viesus.com> to request a trial.
{% endstep %}

{% step %}

## Create an enhancement configuration

Create `viesusini.json` with a minimal enhancement configuration:

```json
{
  "Config": {
    "Enhancemode": 1,
    "NoiseRedMode": 1,
    "SHPmode": 1,
    "FDmode": 1,
    "RERmode": 1,
    "FRmode": 1,
    "ARmode": 2
  },
  "Other": {
    "JpegComprQuality": 95
  }
}
```

This enables color correction, noise reduction, sharpening, face detection, red-eye removal, face reconstruction, and AI artifact removal for each embedded image in the PDF.
{% endstep %}

{% step %}

## Enhance your first PDF

Run in stand-alone mode, passing the source PDF, output folder, and your configuration file.

{% tabs %}
{% tab title="Linux" %}

```bash
/usr/local/viesuspdf/bin/viesuspdf \
  /path/to/document.pdf \
  /path/to/output \
  /path/to/viesusini.json
```

{% endtab %}

{% tab title="Windows" %}

```powershell
"C:\Program Files\Imaging Solutions\VIESUS\PDFEnhancer\viesusPDF.exe" ^
  "C:\PDFs\document.pdf" ^
  "C:\Output" ^
  "C:\Config\viesusini.json"
```

{% endtab %}
{% endtabs %}

The PDF Enhancer writes two files to the output folder:

| File                | Description                                               |
| ------------------- | --------------------------------------------------------- |
| `document_dest.pdf` | Enhanced PDF with improved embedded images                |
| `document.pdf.xml`  | Processing report — image counts, statistics, error codes |

The XML file is written last; you can use it as a completion signal in automated pipelines.
{% endstep %}
{% endstepper %}

***

## Common issues at setup

| Symptom                                 | Cause                                                                     | Fix                                                                                                                         |
| --------------------------------------- | ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| License not recognised / no enhancement | GUID missing/incorrect in `settings.json`, or activation file not applied | For GUID, check the `guid` field in `settings.json`; for Activation Key, see [Activation Key](/licensing/activation-key.md) |
| Output PDF identical to input           | No qualifying images found                                                | Check the XML report for image counts and skip reasons                                                                      |
| `viesusPDF` not found                   | Installation incomplete or PATH not set                                   | Verify installation directory and restart the terminal                                                                      |
| Permission denied on output folder      | Output folder not writable                                                | `chmod 775 /path/to/output` (Linux) or check folder permissions (Windows)                                                   |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.viesus.com/get-started/quickstart-pdf-enhancer.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.