Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document and provide examples of usage for the content scanner #56

Open
merkata opened this issue Feb 22, 2024 · 0 comments
Open

Document and provide examples of usage for the content scanner #56

merkata opened this issue Feb 22, 2024 · 0 comments

Comments

@merkata
Copy link

merkata commented Feb 22, 2024

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.

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

No branches or pull requests

1 participant