docs: explain custom analyzer docker builds#2056
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates installation documentation to explain how to build a custom presidio-analyzer Docker image using alternative YAML configuration files, and records the change in the changelog.
Changes:
- Added a new installation guide section for building a custom
presidio-analyzerimage with custom analyzer/NLP/recognizer-registry YAML files. - Added configuration checks and troubleshooting pointers for multilingual analyzer setups.
- Updated
CHANGELOG.mdunder[unreleased]to document the new guidance (fixes #1663).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/installation.md | Adds step-by-step instructions for building and running a custom analyzer image with custom YAML configs and validation notes. |
| CHANGELOG.md | Documents the new installation guidance under the unreleased “General -> Changed” section. |
|
@ded-furby please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
|
I’ve applied the two actionable review-thread items and pushed on branch :
|
|
I’ve applied the two actionable review-thread items and pushed
|
| docker run -d -p 5001:3000 mcr.microsoft.com/presidio-anonymizer:latest | ||
| ``` | ||
|
|
||
| #### Building a custom `presidio-analyzer` image |
| - [Customizing NLP models](analyzer/customizing_nlp_models.md) | ||
| - [Recognizer registry configuration](analyzer/recognizer_registry_provider.md) | ||
|
|
||
| ### For PII redaction in images |
| For example: | ||
|
|
||
| ```sh | ||
| cd /path/to/presidio |
Change Description
Document how to build a custom
presidio-analyzerDocker image with alternate analyzer, NLP, and recognizer-registry YAML files.The docs now include:
presidio-analyzer/build contextdocker buildarguments needed to point the Dockerfile at those custom filessupported_languagesmismatches and NLP recognizer warningsIssue reference
Fixes #1663
Checklist
Validation
This is a documentation-only change. I did not run the full Python test/lint suite because no runtime code changed.