Add documentation for building custom Presidio Docker images#2023
Open
Bhavan790 wants to merge 1 commit into
Open
Add documentation for building custom Presidio Docker images#2023Bhavan790 wants to merge 1 commit into
Bhavan790 wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
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.,
\#,\##,\-,\*, andpresidio\_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.yamlenablement 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
Author
|
@microsoft-github-policy-service agree |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds comprehensive documentation on how to build custom Presidio Docker images with support for additional languages.
Issue
Closes #1663
Changes
docs/building_custom_docker_images.mdHow to Test
Related Issues
Resolves #1663