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

Add Disclaimer to the Kubo integration doc #373

Merged
merged 3 commits into from
Jun 1, 2023

Conversation

ischasny
Copy link
Contributor

@ischasny ischasny commented Jun 1, 2023

See this for context

@ischasny ischasny requested a review from masih June 1, 2023 16:13
@ischasny
Copy link
Contributor Author

ischasny commented Jun 1, 2023

CC @lidel

Copy link

@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.

sgtm, at least sets expectation YMMV 🙏

README.md Outdated
@@ -136,7 +139,7 @@ To configure `index-provider` to expose the delegated routing server, use the fo
"DelegatedRouting": {
"ListenMultiaddr": "/ip4/0.0.0.0/tcp/50617",
"ProviderID": "PEER ID OF YOUR IPFS NODE",
"Addrs": // List of multiaddresses that you'd like to be advertised to IPNI. If not specified, Swarm addresses of the Kubo node will be used.
"Addrs": [] // List of multiaddresses that you'd like to be advertised to IPNI
Copy link

@lidel lidel Jun 1, 2023

Choose a reason for hiding this comment

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

@jtsmedley would specifying Announce addrs here instead of Kubo solve the problem you had in ipfs/kubo#9823?

@ischasny should we add comment that this list, if not empty, overrides any Addrs sent by the client?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you. Adding.

@codecov-commenter
Copy link

Codecov Report

Patch coverage has no change and project coverage change: +0.16 🎉

Comparison is base (7e76f92) 50.97% compared to head (f01e13e) 51.13%.

❗ Current head f01e13e differs from pull request most recent head f3a6326. Consider uploading reports for the commit f3a6326 to get more accurate results

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #373      +/-   ##
==========================================
+ Coverage   50.97%   51.13%   +0.16%     
==========================================
  Files          61       61              
  Lines        4875     4875              
==========================================
+ Hits         2485     2493       +8     
+ Misses       2084     2077       -7     
+ Partials      306      305       -1     

see 3 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@ischasny ischasny merged commit ad28fa6 into main Jun 1, 2023
@ischasny ischasny deleted the ivan/fix-kubo-integration-docs branch June 1, 2023 16:39
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.

4 participants