DokAudit for TYPO3
Accessible PDFs directly in TYPO3. Links and content elements stay exactly as they are.
The DokAudit extension checks the PDFs in your TYPO3 file list against PDF/UA-1, WCAG 2.2 and BITV 2.0 (Germany’s federal accessibility ordinance for IT, based on EN 301 549) and replaces them with the remediated version. The file keeps its sys_file UID. All links, content elements and file references remain valid.
- TYPO3 12.4 LTS and 13.4 LTS
- Original backed up, restore with one click
- Licence GPL-2.0-or-later
- 20 trial credits = 100 pages
Try it free · View the live demo · Book a call
What the extension does
The extension connects your TYPO3 installation to DokAudit. It finds the PDFs in the file list, hands them over for checking and remediation and then swaps them.
- Checks against PDF/UA-1, WCAG 2.2 and BITV 2.0: DokAudit checks every PDF, repairs it and then checks it again. In the module you see the score before and after, the seals achieved (PDF/UA-1, WCAG 2.2, PDF/A-2a) and the link to the test report in the DokAudit hub.
- Replaced in place: The remediated version replaces the file via TYPO3’s file management. The sys_file UID and the storage location stay the same. You do not need to touch links, content elements or file references.
- Original backed up: Before replacing a file, the extension stores the original in the folder /_dokaudit_backup/ in the same storage. “Restore original” puts it back with one click.
- Replaced only if it improves: The file is only swapped if the score rises by at least the configured minimum gain (default: 1 point). Otherwise the original stays online.
- New PDFs queued automatically: Newly uploaded or replaced PDFs are picked up in the next sync. If a file is uploaded again while it is being processed, the extension discards the result and checks the new version.
- “Check only” mode: In “check only” mode the extension replaces nothing. You first see where your PDFs stand and switch on replacement later.
Nothing changes for your editors
Editors upload PDFs to the file list and link them as before. The sync runs in the background via the scheduler.
You decide which storages and folders are included, for example only /formulare/ and /satzungen/. The backup folder as well as _processed_ and _temp_ are excluded. The extension skips PDFs above a configurable size.
Every file goes through the same stages:
- New: detected and queued for the sync
- Submitted: DokAudit checks, repairs and re-checks
- Replaced: remediated version online, original backed up
- Checked: checked only, or no sufficient improvement
- Waiting: not enough credits, processing continues as soon as credits are available again
The module File → DokAudit
The backend module is available to administrators. It fetches finished results as soon as you open it. Its interface is currently in German.
- Overview: Connection and credit balance, key figures and the list of all registered PDFs with score before and after.
- Actions: “Sync now” (Jetzt abgleichen) for all files, and “Restore original” (Original wiederherstellen) and “Check again” (Erneut prüfen) for each file.
- Seals and test report: For each document, the seals achieved and a link to the test report in the DokAudit hub, as evidence for your records.
- Settings in the module: You enter the API address and key directly in the module. The key is verified when you save it, and the organisation it belongs to is displayed.
- Notices: The module points out PDFs in the file list that have not yet been checked and warns when credits are running low.
- Update notice: When a newer version of the extension is available, the module says so and links to the ZIP download.
Set up in three steps
Once installed, setting it up takes a few minutes.
- Create an API key: In the DokAudit hub, go to Integrations → API keys and create a key with write permission. The key belongs to your organisation: documents appear in its hub and are billed to its credit balance.
- Enter the key in TYPO3: In the module File → DokAudit → Settings, enter the API address and key. All options are also available under Settings → Extension Configuration → dokaudit.
- Create a scheduler task: Create a scheduler task “Execute console commands” with dokaudit:sync, for example every 10 minutes. From then on the sync runs by itself.
Installation and requirements
Standard route – ZIP download: Download the current version as a ZIP and upload it in the Extension Manager. The folder in the ZIP is called dokaudit.
Composer variant: In Composer-based installations without upload in the Extension Manager, unpack the ZIP into a folder of your project and add it as a path repository: composer config repositories.dokaudit '{"type":"path","url":"path/to/dokaudit"}', then composer require dokaudit/typo3-dokaudit:@dev and vendor/bin/typo3 extension:setup. The last command creates the table tx_dokaudit_file.
On the console, vendor/bin/typo3 dokaudit:sync syncs the files, and vendor/bin/typo3 dokaudit:restore with the UID of the file restores an original.
- TYPO3 12.4 LTS or 13.4 LTS
- PHP 8.1 or later
- Scheduler system extension for the regular sync
- A DokAudit account with an API key
DokAudit for Drupal · REST API and other integrations
Costs, licence and data protection
- Billed via your credits: The extension itself is free of charge. DokAudit bills checking and remediation just as in the hub: 1 credit per 5 pages or part thereof, from €0.50 per page in the public sector plan, AI included. See pricing
- GPL licence: The extension is licensed under GPL-2.0-or-later. You can inspect and adapt the source code.
- Data protection: Only the PDF files are transferred, encrypted via HTTPS. Processing takes place in an ISO/IEC 27001-certified data centre in Germany under your organisation’s data processing agreement.
- Your own instance: The API address is configurable. If you run DokAudit in your own data centre, connect the extension to your instance.
Frequently asked questions
- What happens to links to the PDFs?
- Nothing. The file keeps its sys_file UID and its storage location; only the content is swapped. Links in text, content elements and file references keep pointing to the same file.
- What if the remediated version is worse than the original?
- Then nothing is replaced. The extension only swaps a file if the score rises by at least the configured minimum gain. Once a file has been replaced, the original sits in the backup folder and can be restored with one click.
- Are files transferred to third parties?
- The extension only transfers the PDF files themselves, encrypted via HTTPS to DokAudit. They are processed in an ISO/IEC 27001-certified data centre in Germany under your organisation’s data processing agreement. For AI tasks, DokAudit uses a provider named as a sub-processor in the data processing agreement (in German). AI can be restricted to providers in the EU or switched off.
- Does the extension run on TYPO3 12?
- Yes. TYPO3 12.4 LTS and 13.4 LTS are supported with PHP 8.1 or later. TYPO3 11 and older versions are not supported.
- Do I need Composer?
- No. The standard route is the ZIP download: download it and install it in the Extension Manager. If your installation uses Composer, add the unpacked folder as a path repository and install the extension with composer require dokaudit/typo3-dokaudit:@dev.
- What does it cost?
- The extension is free of charge and licensed under the GPL. Checking and remediation use credits just as in the hub: 1 credit per 5 pages or part thereof, from €0.50 per page in the public sector plan. When you register, you receive 20 credits for testing, which is 100 pages. If the balance is insufficient, the file waits until credits are available again.
- Can I check first without replacing anything?
- Yes. In “check only” mode you see scores and test reports while the files stay unchanged. You can also restrict the sync to individual storages or folders.
Make the PDFs in TYPO3 accessible
Register, create an API key and enter it in TYPO3. 20 trial credits for 100 pages are free. We are happy to answer questions about your installation in a call.
Try it free · View the live demo · Book a call