Skip to content

docs: add signer-node HTTPS proxy guidance#1825

Open
unclekaldoteth wants to merge 1 commit intostacks-network:masterfrom
unclekaldoteth:codex/signer-node-https-docs
Open

docs: add signer-node HTTPS proxy guidance#1825
unclekaldoteth wants to merge 1 commit intostacks-network:masterfrom
unclekaldoteth:codex/signer-node-https-docs

Conversation

@unclekaldoteth
Copy link

@unclekaldoteth unclekaldoteth commented Feb 6, 2026

Fixes #1627

Summary

  • Add documentation for running signer and stacks-node over encrypted links when they are hosted on separate machines.
  • Document a reverse-proxy pattern that preserves required IP:PORT config fields while adding TLS between hosts.
  • Add an explicit operator validation checklist.

Changes

  • docs/operate/run-a-signer/README.md
    • Added an Optional: TLS between signer and node on separate hosts section.
    • Added traffic-path mapping for both directions:
    • stacks-node -> signer events flow through local proxy + HTTPS.
    • stacks-signer -> stacks-node RPC flow through local proxy + HTTPS.
    • Added concrete signer-config.toml and node-config.toml examples using loopback proxy endpoints.
    • Added Nginx examples for node host and signer host.
    • Added validation checklist (curl, certificate verification, logs).
  • docs/reference/node-operations/signer-configuration.md
    • Added guidance that node_host and events_observer.endpoint remain IP:PORT values (not https://...).
    • Added note to use local loopback proxies for TLS and linked to run guide.

Testing

npx --yes markdownlint-cli --disable MD001 MD013 MD022 MD024 MD031 MD034 MD040 -- docs/operate/run-a-signer/README.md docs/reference/node-operations/signer-configuration.md
echo "exit_code=$?"
# exit_code=0

Checklist

  • Required documentation updates included
  • Changes are scoped to docs only
  • Test evidence included

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

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.

Add docs for using https between a singer and stacks-node

2 participants