Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Document and provide examples of usage for the content scanner

Open
#56 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start by reviewing the existing docs/ folder and the content scanner API to determine how clients are expected to consume it. Document the recommended homeserver integration, explain whether a reverse proxy is needed, and add configuration and usage examples covering the requested setups. Done means a newcomer can follow the tutorial and understand the supported approach.

Written by the indexing model from the issue text.

Description

Is your feature request related to a problem? Please describe.

I'm having trouble understanding how the content scanner is supposed to be used (I'm fairly new to this, so apologies if I'm missing something obvious here). How is the API supposed to be consumed - are clients referring to it, do you put a reverse proxy in front of (your) homeserver that intercepts requests to media and passes them to the scanner, other approaches? I'm not sure what is possible and also what is recommended.

Describe the solution you'd like

Ideally there is documentation on how you can use this with a home server and an example conf in case something additional is required (on homeserver.yaml or a reverse proxy setup)

Describe alternatives you've considered

I considered trying this with a reverse proxy, though I still wanted to open this request for docs - if there are clarifying comments on the request, I can open a doc PR.

Additional context

Hope to have a tutorial and examples under docs/ folder.

Dominant language
Python
Stars
25
Forks
16
Avg merge
1d 7h
Merged PRs (30d)
12

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from element-hq/matrix-content-scanner-python

All issues in element-hq/matrix-content-scanner-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.