Skip to content

docs(security): update static files examples to use StaticFilesMiddleware service (closes #345)#544

Merged
s2x merged 1 commit into
masterfrom
fix/issue-345-readme-serve-files-deprecated
Jul 3, 2026
Merged

docs(security): update static files examples to use StaticFilesMiddleware service (closes #345)#544
s2x merged 1 commit into
masterfrom
fix/issue-345-readme-serve-files-deprecated

Conversation

@s2x

@s2x s2x commented Jul 3, 2026

Copy link
Copy Markdown
Collaborator

Description

Closes #345

Changes

  • Updated Static Files Protection section:
    • Changed intro text to describe service registration pattern instead of the deprecated serve_files server option
    • Updated Extension Allowlist YAML example to use StaticFilesMiddleware service with and constructor arguments
    • Updated Symlink Protection YAML example to use StaticFilesMiddleware service with and constructor arguments
    • Updated Security Considerations to reference and instead of deprecated root_dir and follow_symlinks
  • Added CHANGELOG.md entry under [Unreleased] → Docs

Acceptance Criteria

Code Review

  • Passed code review
  • All review comments addressed

@s2x s2x self-assigned this Jul 3, 2026
@s2x
s2x merged commit cf5a83a into master Jul 3, 2026
12 checks passed
@s2x
s2x deleted the fix/issue-345-readme-serve-files-deprecated branch July 3, 2026 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] README 'What's new in this fork' presents servers.serve_files as a feature, but it's deprecated

1 participant