Skip to content

feat: add a guide on running a node behind a proxy#1836

Open
simone-stacks wants to merge 11 commits intomasterfrom
feat/node-proxy
Open

feat: add a guide on running a node behind a proxy#1836
simone-stacks wants to merge 11 commits intomasterfrom
feat/node-proxy

Conversation

@simone-stacks
Copy link

@simone-stacks simone-stacks commented Feb 25, 2026

Summary

  • Adds a new guide covering how to run a Stacks node behind a reverse proxy with rate limiting
  • Includes production-tested configurations for both HAProxy and Nginx
  • Updates the Docker guide with minor tips

Additional info

Closes #1762
Closes https://github.com/stx-labs/core-epics/issues/110

Checklist

  • Review HAProxy and Nginx configuration examples for accuracy

@simone-stacks simone-stacks requested a review from wileyj February 25, 2026 11:25
Copy link
Contributor

@wileyj wileyj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small changes here and there, but overall it's in good shape.
only requirement to merge is ensure the links are all correct - a few appear to point to old docs (noting that this PR also cleans up deprecated file paths).

simone-stacks and others added 7 commits March 5, 2026 10:55
Co-authored-by: wileyj <2847772+wileyj@users.noreply.github.com>
Co-authored-by: wileyj <2847772+wileyj@users.noreply.github.com>
Co-authored-by: wileyj <2847772+wileyj@users.noreply.github.com>
Co-authored-by: wileyj <2847772+wileyj@users.noreply.github.com>
Co-authored-by: wileyj <2847772+wileyj@users.noreply.github.com>
@simone-stacks
Copy link
Author

In commit 651c964 I added a few improvements:

  • In the ports table, Bitcoin RPC listed 8332 but HAProxy was binding to 18332 (testnet). Aligned to mainnet default 8332 and updated the table to show both variants.
  • All three HAProxy frontends share one Abuse table, meaning a client that trips the rate limit on any service gets blocked from all of them. Added a comment explaining this behavior.
  • Added proxy_set_header directives for Nginx so the Stacks node sees real client IPs in its logs instead of 127.0.0.1 (helps with debugging and log correlation)

Do you think those changes are correct @wileyj?

@wileyj
Copy link
Contributor

wileyj commented Mar 5, 2026

In commit 651c964 I added a few improvements:

  • In the ports table, Bitcoin RPC listed 8332 but HAProxy was binding to 18332 (testnet). Aligned to mainnet default 8332 and updated the table to show both variants.
  • All three HAProxy frontends share one Abuse table, meaning a client that trips the rate limit on any service gets blocked from all of them. Added a comment explaining this behavior.
  • Added proxy_set_header directives for Nginx so the Stacks node sees real client IPs in its logs instead of 127.0.0.1 (helps with debugging and log correlation)

Do you think those changes are correct @wileyj?

will double check, thanks! i think you are correct that the links i flagged are all correct here, since the content was moved (but the old files are still present, which is where my confusion came from - i see the deletion, but not the move).

Co-authored-by: wileyj <2847772+wileyj@users.noreply.github.com>
Copy link
Collaborator

@eric-stacks eric-stacks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

formatting and file structure lgtm

@eric-stacks
Copy link
Collaborator

@simone-stacks just confirming if all the changes were resolved? looks like its good to go?

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

Successfully merging this pull request may close these issues.

Document how to run a node behind a proxy

3 participants