[Migrated from ohttp-relay] - feat+docs: add complete setup docs/guides #1245
Description
Which crate is this feature request for?
ohttp-relay
Please describe the feature you'd like to see added.
Describe the enhancement
A step towards the adoption of Oblivious HTTP, in my view, is making it simple for any end-user set up and host their own ohttp-relay, even as an ephemeral one for timed use (?).
I don't know any other FOSS Oblivious HTTP relay projects, besides this one. AFAIK you can use hosted "alike" versions with Cloudflare Workers and Fastly OHTTP Relay.
ohttp-relay is pretty self-contained and somewhat simple to run and host, but I think we could cover some ground and have richer/complete docs for any user-level.
I have some issues in mind that could help towards the goal afore mentioned:
- docs: add initial setup docs with standard nginx & nohup usage on common cloud infrastructure
- feat+docs(docker): add standard minimal Dockerfile without Nix dependency, and usage documentation
- feat+docs(nix): add Nix Module usage and deployment documentation
- feat(installer): add a friendly setup script guiding user through ohttp-relay setup on common VM systems (?)
I got these inspirations on how we do at fedimint, having the docker images, and the setup script that relies on them allows any user-level to pretty much setup a federation in instants. While having nixpkgs and modules for sophisticated users.
Use case
Improve adoption, and usage of ohttp-relay by making it simple and easy to host.
Additional context
TBD
Is your feature related to a problem, if so please describe it.
No response
Describe the solution you'd like
No response
Describe any alternatives you've considered
No response
Please leave any additional context
Originally posted in the ohttp-relay payjoin/ohttp-relay#37 additional discussion can be found there