Add quickstart guide for ohttp-relay on basic ubuntu server #90
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DanGould
reviewed
Feb 18, 2025
There was a problem hiding this comment.
just some very basic curl requests to make sure their server is receiving well
This is the quickest way for us to meaningfully get off zero. I like it.
Should we strip out some of the details like PORT selection in our .conf files and leave it as they exist here
A concrete tutorial can state its opinion on explicit port definition IMO.
| @@ -0,0 +1,92 @@ | |||
| # Quickstart ohttp relay | |||
|
|
|||
| We'll demostrate how you can setup an ohttp server on common cloud insfrastructure on something like [](483) using the `ohttp-relay` crate in Payjoin Dev Kit. This should take about 30 minutes. This tutorial assumes you have a basic understanding of the AWS infrastructure. | |||
There was a problem hiding this comment.
Yeah, sorry the copy still needs some cleanup. I had started making the guide thinking I would need to make it aws specific but its pretty easy to see that's not necessary.
benalleng
force-pushed
the
ohttp-relay-tutorial
branch
3 times, most recently
from
4b1ba6f to
6fae84a
Compare
4 tasks
benalleng
force-pushed
the
ohttp-relay-tutorial
branch
from
c482eb8 to
67350da
Compare
benalleng
changed the title
benalleng
force-pushed
the
ohttp-relay-tutorial
branch
from
67350da to
e8cc194
Compare
benalleng
commented
Feb 20, 2025
Comment on lines
95
to
141
|
|
||
| This curl request should occur in 2 stages | ||
| 1. The proxy CONNECT request that passes through your relay to the `https://payjo.in` directory | ||
| 2. The GET request on `/ohttp-keys` that will return a binary encoded output | ||
| A successful test should return a 200/OK response on both of these steps | ||
|
|
||
| ```sh | ||
| curl -vk --proxy-insecure --proxy https://{your-relay-public-ip} https://payjo.in/ohttp-keys --output - | ||
| ``` |
There was a problem hiding this comment.
I assume that these keys could change is there a nice way to check and make sure the keys we are receiving are what we expect?
There was a problem hiding this comment.
As opposed to something like just telling them to verify that the response == some_key_value
benalleng
force-pushed
the
ohttp-relay-tutorial
branch
2 times, most recently
from
81541b0 to
7add53b
Compare
benalleng
force-pushed
the
ohttp-relay-tutorial
branch
from
7add53b to
80bd7e6
Compare
benalleng
force-pushed
the
ohttp-relay-tutorial
branch
from
80bd7e6 to
16936fb
Compare
This issue payjoin/ohttp-relay#37 outlines a need for some documentation for a quickstart guide on a docker server with a nginx proxy. This iteration uses the existing dockerfile with a nginx reverse proxy in front.
benalleng
force-pushed
the
ohttp-relay-tutorial
branch
from
16936fb to
5bd140d
Compare
This commit adds some helpful commands and tips to make it easier to setup and as simple reminders about what is needed for the relay to be setup correctly.
benalleng
force-pushed
the
ohttp-relay-tutorial
branch
from
d235310 to
481e5b4
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This issue payjoin/ohttp-relay#37 outlines a need for some documentation for a quickstart guide on a docker server with an nginx proxy.
You can take a look at the pretty markdown here https://github.com/benalleng/payjoin.org/blob/ohttp-relay-tutorial/docs/tutorials/quickstart-ohttp-relay.md
Still a WIP as there is still some text i need to cleanup and I have some outstanding questions
A few oustanding questions remain with this guide.
Figure out why my current implementation is not quite working correctlyI think this is ready for some double checks as I am able to proxy to the payjo.in directory successfullycurl -vk --proxy-insecure --proxy https://{you-public-ip} https://payjo.in/ohttp-keys --output -command does an ok job of ensuring that the proxy successfully connects and is able to then receive data from the payjo.in directoryShould we strip out some of the details like PORT selection in ourA quickstart guide like this is the time to be opinionated.conffiles and leave it as they exist here