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

Document and provide examples of usage for the content scanner

Offen
#56 0 Kommentare 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Python
Sterne
25
Forks
16
Ø Merge
3 T. 1 Std.
Gemergte PRs (30 T.)
9

Beschreibung

**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.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Beginne mit der Überprüfung des vorhandenen Ordners docs/ und der Content-Scanner-API, um festzustellen, wie Clients sie voraussichtlich verwenden sollen. Dokumentiere die empfohlene Homeserver-Integration, erläutere, ob ein Reverse Proxy erforderlich ist, und füge Konfigurations- und Nutzungsbeispiele hinzu, die die angeforderten Setups abdecken. Als erledigt gilt die Aufgabe, wenn ein Neuling dem Tutorial folgen und den unterstützten Ansatz verstehen kann.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.