Skip to content

Security: jeckyl2010/mkdocs2confluence

SECURITY.md

Security Policy

Supported Versions

Only the latest release receives security fixes.

Version Supported
Latest βœ…
Older ❌

Reporting a Vulnerability

Please do not open a public GitHub issue for security vulnerabilities.

Use GitHub's private vulnerability reporting instead:

πŸ‘‰ Report a vulnerability

You can expect an acknowledgement within a few days and a fix or mitigation within a reasonable timeframe depending on severity.

Scope

This tool runs locally and publishes Markdown content to Confluence. The main risk surface is:

  • Confluence credentials β€” passed via environment variables or mkdocs.yml; never logged or stored by this tool
  • URL handling β€” source links and edit URIs are validated using urlparse hostname matching, not substring checks
  • Dependency vulnerabilities β€” monitored automatically via Dependabot and pip-audit in CI

Kroki diagram rendering

When Mermaid or D2 diagrams are present, diagram source code is sent to a Kroki server for rendering to PNG.

By default this uses the public kroki.io service β€” meaning diagram content leaves your machine and is processed by a third-party server.

If your diagrams contain sensitive or proprietary information, configure a self-hosted Kroki instance in mkdocs.yml:

extra:
  confluence:
    kroki_url: https://kroki.your-company.com

Self-hosting Kroki is straightforward via Docker: docker run -p 8000:8000 yuzutech/kroki.

There aren't any published security advisories