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

kubo rpc: tls and basic http auth guide #1989

Merged
merged 12 commits into from
Feb 11, 2025
Merged

kubo rpc: tls and basic http auth guide #1989

merged 12 commits into from
Feb 11, 2025

Conversation

2color
Copy link
Member

@2color 2color commented Feb 4, 2025

What's in this PR

Add guide on how to set up Caddy for TLS termination and basic http auth in Kubo.

Checklist before merging

  • Link to this guide in
    ::: danger NEVER EXPOSE THE RPC API TO THE PUBLIC INTERNET
    The RPC API provides admin-level access to your Kubo IPFS node, including `+"`/api/v0/config`"+`.
    It is bound to `+"`localhost`"+` by default on purpose. You should never expose it to the public internet, just like you would never expose a SQL database or other backend service.
    If you are looking for an interface designed for browsers and public internet, consider implementation-agnostic [HTTP Gateway](../../reference/http/gateway.md) instead.
    :::
  • Passing all required checks (The beta Check Markdown links for modified files check is not required)

@lidel lidel changed the title add tls and basic http auth guide kubo rpc: tls and basic http auth guide Feb 11, 2025
Copy link
Member

@lidel lidel left a comment

Choose a reason for hiding this comment

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

thanks, lgtm, pushed small cosmetics, and tested API generator, both look fine.
optional suggestions below but also ok to merge as-is

docs/how-to/kubo-tls-auth.md Outdated Show resolved Hide resolved
docs/.vuepress/config.js Outdated Show resolved Hide resolved
@2color 2color merged commit f5e9849 into main Feb 11, 2025
5 checks passed
@2color 2color deleted the add-kubo-tls-guide branch February 11, 2025 11:35
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.

2 participants