-
-
Notifications
You must be signed in to change notification settings - Fork 3k
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
feat: reprovider warning and announce-on|off profiles #10524
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -183,6 +183,8 @@ config file at runtime. | |
- [`flatfs` profile](#flatfs-profile) | ||
- [`badgerds` profile](#badgerds-profile) | ||
- [`lowpower` profile](#lowpower-profile) | ||
- [`announce-off` profile](#announce-off-profile) | ||
- [`announce-on` profile](#announce-on-profile) | ||
- [`legacy-cid-v0` profile](#legacy-cid-v0-profile) | ||
- [`test-cid-v1` profile](#test-cid-v1-profile) | ||
- [Types](#types) | ||
|
@@ -299,7 +301,7 @@ Map of HTTP headers to set on responses from the RPC (`/api/v0`) HTTP server. | |
Example: | ||
```json | ||
{ | ||
"Foo": ["bar"] | ||
"Foo": ["bar"] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ℹ️ replaced tabs with space in entire file for consistency |
||
} | ||
``` | ||
|
||
|
@@ -534,27 +536,27 @@ Default: | |
``` | ||
{ | ||
"mounts": [ | ||
{ | ||
"child": { | ||
"path": "blocks", | ||
"shardFunc": "/repo/flatfs/shard/v1/next-to-last/2", | ||
"sync": true, | ||
"type": "flatfs" | ||
}, | ||
"mountpoint": "/blocks", | ||
"prefix": "flatfs.datastore", | ||
"type": "measure" | ||
}, | ||
{ | ||
"child": { | ||
"compression": "none", | ||
"path": "datastore", | ||
"type": "levelds" | ||
}, | ||
"mountpoint": "/", | ||
"prefix": "leveldb.datastore", | ||
"type": "measure" | ||
} | ||
{ | ||
"child": { | ||
"path": "blocks", | ||
"shardFunc": "/repo/flatfs/shard/v1/next-to-last/2", | ||
"sync": true, | ||
"type": "flatfs" | ||
}, | ||
"mountpoint": "/blocks", | ||
"prefix": "flatfs.datastore", | ||
"type": "measure" | ||
}, | ||
{ | ||
"child": { | ||
"compression": "none", | ||
"path": "datastore", | ||
"type": "levelds" | ||
}, | ||
"mountpoint": "/", | ||
"prefix": "leveldb.datastore", | ||
"type": "measure" | ||
} | ||
], | ||
"type": "mount" | ||
} | ||
|
@@ -1126,7 +1128,7 @@ Example: | |
"API" : { | ||
"Endpoint" : "https://pinningservice.tld:1234/my/api/path", | ||
"Key" : "someOpaqueKey" | ||
} | ||
} | ||
} | ||
} | ||
} | ||
|
@@ -2420,18 +2422,30 @@ This profile may only be applied when first initializing the node. | |
|
||
### `lowpower` profile | ||
|
||
Reduces daemon overhead on the system. Affects node | ||
functionality - performance of content discovery and data | ||
fetching may be degraded. | ||
|
||
> [!CAUTION] | ||
> Local data won't be announced on routing systems like Amino DHT. | ||
Reduces daemon overhead on the system by disabling optional swarm services. | ||
|
||
- [`Routing.Type`](#routingtype) set to `autoclient` (no DHT server, only client). | ||
- `Swarm.ConnMgr` set to maintain minimum number of p2p connections at a time. | ||
- Disables [`Reprovider`](#reprovider) service → no CID will be announced on Amino DHT and other routing systems(!) | ||
- Disables [`AutoNAT`](#autonat). | ||
- Disables [`Swam.RelayService`](#swarmrelayservice). | ||
|
||
> [!NOTE] | ||
> This profile is provided for legacy reasons. | ||
> With modern Kubo setting the above should not be necessary. | ||
|
||
### `announce-off` profile | ||
|
||
Disables [Reprovider](#reprovider) system (and announcing to Amino DHT). | ||
|
||
> [!CAUTION] | ||
> The main use case for this is setups with manual Peering.Peers config. | ||
> Data from this node will not be announced on the DHT. This will make | ||
> DHT-based routing an data retrieval impossible if this node is the only | ||
> one hosting it, and other peers are not already connected to it. | ||
|
||
### `announce-on` profile | ||
|
||
Use this profile with caution. | ||
(Re-)enables [Reprovider](#reprovider) system (reverts [`announce-off` profile](#annouce-off-profile). | ||
|
||
### `legacy-cid-v0` profile | ||
|
||
|
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo: wet -> set