Skip to content

Add documentation for building custom Presidio Docker images#2023

Open
Bhavan790 wants to merge 1 commit into
microsoft:mainfrom
Bhavan790:add-docker-docs
Open

Add documentation for building custom Presidio Docker images#2023
Bhavan790 wants to merge 1 commit into
microsoft:mainfrom
Bhavan790:add-docker-docs

Conversation

@Bhavan790
Copy link
Copy Markdown

Summary

This PR adds comprehensive documentation on how to build custom Presidio Docker images with support for additional languages.

Issue

Closes #1663

Changes

  • Added docs/building_custom_docker_images.md
  • Documentation covers:
    • Key configuration files to modify
    • Step-by-step guide to enable language support (German example)
    • NLP backend options (Spacy vs Stanza)
    • Docker build process
    • Common issues and solutions
    • Testing instructions

How to Test

  1. Review the new documentation file
  2. Verify the formatting is correct
  3. Check that the examples are clear

Related Issues

Resolves #1663

Copilot AI review requested due to automatic review settings May 15, 2026 06:10
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a new documentation page intended to guide users through building custom Presidio Docker images with support for additional languages (e.g., enabling German recognizers) and alternative NLP backends.

Changes:

  • Added a new doc page: docs/building_custom_docker_images.md
  • Introduced an example flow for enabling German recognizers via default_recognizers.yaml
Comments suppressed due to low confidence (3)

docs/building_custom_docker_images.md:27

  • Most Markdown syntax is escaped (e.g., \#, \##, \-, \*, and presidio\_analyzer), which will render as literal backslashes instead of headings/lists/emphasis in MkDocs. These escapes should be removed so the page renders correctly as Markdown.
\# Building Custom Presidio Docker Images



\## Overview



This guide explains how to build custom Presidio Docker images with support for additional languages beyond English.



\*Common Use Cases:\*

\- Add German, Spanish, French language support

\- Use different NLP backends (Spacy vs Stanza)

\- Optimize for production deployments

docs/building_custom_docker_images.md:103

  • The YAML example inside the fenced code block contains literal   entities and leading backslashes (e.g., \- name:), so it is not valid YAML when copied. Replace the entities with real spaces, remove the backslashes, and keep normal YAML indentation so users can copy/paste the snippet.
```yaml

\- name: DeTaxIdRecognizer

  supported\_languages:

  - de

  type: predefined

  enabled: true



\- name: DePassportRecognizer

  supported\_languages:

  - de

  type: predefined

  enabled: true

docs/building_custom_docker_images.md:105

  • The PR description says this doc covers NLP backend options, Docker build process, common issues/solutions, and testing instructions, but the current file ends right after the initial default_recognizers.yaml enablement example. Either expand the document to include the promised sections or adjust the PR description to match the current scope.
\### Example: Add German Language Support



1\. Open presidio-analyzer/presidio\_analyzer/conf/default\_recognizers.yaml



2\. Find the "Germany recognizers" section (around line 312)



3\. Change enabled: false to enabled: true:



```yaml

\- name: DeTaxIdRecognizer

  supported\_languages:

  - de

  type: predefined

  enabled: true



\- name: DePassportRecognizer

  supported\_languages:

  - de

  type: predefined

  enabled: true


Comment thread docs/building_custom_docker_images.md
Comment thread docs/building_custom_docker_images.md
Copy link
Copy Markdown
Author

@Bhavan790 Bhavan790 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ready for review

@Bhavan790
Copy link
Copy Markdown
Author

@microsoft-github-policy-service agree

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

More elaborate description how to build custom Docker images for Presidio

2 participants