needtoknow needtoknow needtoknow
  • Get started
  • Guide
    • Concepts Subjects, authorizers, filters, strategies
    • Combining and tenants Layered rules, multi-tenancy
    • Hybrid search Keyword and vector, fused
    • Security model What is guaranteed and what is assumed
    • Operations Caching, audit, tracing, failure modes
    • Production checklist Launch checks, failure modes
    • Benchmarks Recall, latency and throughput, measured
  • Integrations
    • Overview Every backend and authorizer
    • PostgreSQL + pgvector Filter inside SQL
    • Qdrant Filter as a query_filter
    • Milvus Parameterized filters
    • MongoDB Atlas Vector Search
    • Weaviate Filtered vector search
    • Redis Query Engine KNN
    • Elasticsearch, OpenSearch Filtered kNN
    • OpenFGA Relationship-based access
    • Open Policy Agent Policy as code
    • LangChain Retriever and tools
    • LlamaIndex Retriever and postprocessor
    • Haystack Retriever component
  • API
/

Guide

  • Getting started
  • Concepts
  • Combining authorizers and multi-tenancy
  • Hybrid search
  • Your own vectors
  • Reranking
  • Security model
  • Threat model
  • Revocation and consistency
  • Operations
  • Incident runbook
  • Production checklist
  • Compliance mapping
  • For security reviewers

Integrations

  • Integrations
  • PostgreSQL + pgvector
  • Chroma
  • Elasticsearch and OpenSearch
  • Qdrant
  • Milvus
  • MongoDB Atlas Vector Search
  • Weaviate
  • Redis vector search
  • LanceDB
  • Open Policy Agent
  • OpenFGA
  • SpiceDB
  • Cerbos
  • Cedar
  • Google Drive
  • LangChain
  • LlamaIndex
  • Haystack
  • MCP
  • Agent frameworks
  • FastAPI

Reference

  • API reference
  • Extending needtoknow
  • Supported configurations
  • Benchmarks
  • Changelog
  • Contributing
Edit this page
  1. needtoknow /
  2. Contributing
View as Markdown Open in ChatGPT Open in Claude

Contributing#

needtoknow is developed in the open, and contributions of every size are welcome: bug reports, documentation, tests, and new backends or authorizers.

  • Contributing guide: setting up, running the tests, and what a pull request needs.

  • Governance: how decisions are made.

  • Code of conduct.

  • Security policy: report vulnerabilities privately.

  • Architecture decision records: why the project is built the way it is.

Questions and ideas go to GitHub issues.

Previous
Changelog

2026, Syed Muzakkir Hussain

Made with Sphinx and Shibuya theme.