mirror of
https://github.com/ipfs/kubo.git
synced 2026-02-21 10:27:46 +08:00
Jorropo
parent
5b9442cfed
commit
1f5763f787
@ -12,7 +12,7 @@ Kubo was the first IPFS implementation and is the most widely used one today. Im
|
||||
Featureset
|
||||
- Runs an IPFS-Node as a network service
|
||||
- [Command Line Interface](https://docs.ipfs.tech/reference/kubo/cli/) to IPFS-Nodes
|
||||
- Local [Web2-to-Web3 HTTP Gateway functionality](https://github.com/ipfs/specs/tree/main/http-gateways#readme)
|
||||
- Local [Web2-to-Web3 HTTP Gateway functionality](https://github.com/ipfs/specs/tree/main/http-gateways#readme)
|
||||
- HTTP RPC API (`/api/v0`) to access and control the daemon
|
||||
- IPFS's internal Webgui can be used to manage the Kubo nodes
|
||||
|
||||
@ -381,7 +381,6 @@ Some places to get you started on the codebase:
|
||||
- libp2p
|
||||
- libp2p: https://github.com/libp2p/go-libp2p
|
||||
- DHT: https://github.com/libp2p/go-libp2p-kad-dht
|
||||
- PubSub: https://github.com/libp2p/go-libp2p-pubsub
|
||||
- [IPFS : The `Add` command demystified](https://github.com/ipfs/kubo/tree/master/docs/add-code-flow.md)
|
||||
|
||||
### Map of Implemented Subsystems
|
||||
|
||||
@ -171,7 +171,7 @@ Headers.
|
||||
cmds.BoolOption(enableGCKwd, "Enable automatic periodic repo garbage collection"),
|
||||
cmds.BoolOption(adjustFDLimitKwd, "Check and raise file descriptor limits if needed").WithDefault(true),
|
||||
cmds.BoolOption(migrateKwd, "If true, assume yes at the migrate prompt. If false, assume no."),
|
||||
cmds.BoolOption(enablePubSubKwd, "Enable experimental pubsub feature. Overrides Pubsub.Enabled config."),
|
||||
cmds.BoolOption(enablePubSubKwd, "DEPRECATED"),
|
||||
cmds.BoolOption(enableIPNSPubSubKwd, "Enable IPNS over pubsub. Implicitly enables pubsub, overrides Ipns.UsePubsub config."),
|
||||
cmds.BoolOption(enableMultiplexKwd, "DEPRECATED"),
|
||||
cmds.StringOption(agentVersionSuffix, "Optional suffix to the AgentVersion presented by `ipfs id` and also advertised through BitSwap."),
|
||||
|
||||
@ -16,14 +16,14 @@ import (
|
||||
)
|
||||
|
||||
var PubsubCmd = &cmds.Command{
|
||||
Status: cmds.Experimental,
|
||||
Status: cmds.Deprecated,
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "An experimental publish-subscribe system on ipfs.",
|
||||
ShortDescription: `
|
||||
ipfs pubsub allows you to publish messages to a given topic, and also to
|
||||
subscribe to new messages on a given topic.
|
||||
|
||||
EXPERIMENTAL FEATURE
|
||||
DEPRECATED FEATURE (see https://github.com/ipfs/kubo/issues/9717)
|
||||
|
||||
It is not intended in its current state to be used in a production
|
||||
environment. To use, the daemon must be run with
|
||||
@ -46,13 +46,13 @@ type pubsubMessage struct {
|
||||
}
|
||||
|
||||
var PubsubSubCmd = &cmds.Command{
|
||||
Status: cmds.Experimental,
|
||||
Status: cmds.Deprecated,
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Subscribe to messages on a given topic.",
|
||||
ShortDescription: `
|
||||
ipfs pubsub sub subscribes to messages on a given topic.
|
||||
|
||||
EXPERIMENTAL FEATURE
|
||||
DEPRECATED FEATURE (see https://github.com/ipfs/kubo/issues/9717)
|
||||
|
||||
It is not intended in its current state to be used in a production
|
||||
environment. To use, the daemon must be run with
|
||||
@ -145,14 +145,14 @@ TOPIC AND DATA ENCODING
|
||||
}
|
||||
|
||||
var PubsubPubCmd = &cmds.Command{
|
||||
Status: cmds.Experimental,
|
||||
Status: cmds.Deprecated,
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Publish data to a given pubsub topic.",
|
||||
ShortDescription: `
|
||||
ipfs pubsub pub publishes a message to a specified topic.
|
||||
It reads binary data from stdin or a file.
|
||||
|
||||
EXPERIMENTAL FEATURE
|
||||
DEPRECATED FEATURE (see https://github.com/ipfs/kubo/issues/9717)
|
||||
|
||||
It is not intended in its current state to be used in a production
|
||||
environment. To use, the daemon must be run with
|
||||
@ -201,13 +201,13 @@ HTTP RPC ENCODING
|
||||
}
|
||||
|
||||
var PubsubLsCmd = &cmds.Command{
|
||||
Status: cmds.Experimental,
|
||||
Status: cmds.Deprecated,
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "List subscribed topics by name.",
|
||||
ShortDescription: `
|
||||
ipfs pubsub ls lists out the names of topics you are currently subscribed to.
|
||||
|
||||
EXPERIMENTAL FEATURE
|
||||
DEPRECATED FEATURE (see https://github.com/ipfs/kubo/issues/9717)
|
||||
|
||||
It is not intended in its current state to be used in a production
|
||||
environment. To use, the daemon must be run with
|
||||
@ -273,7 +273,7 @@ func safeTextListEncoder(req *cmds.Request, w io.Writer, list *stringList) error
|
||||
}
|
||||
|
||||
var PubsubPeersCmd = &cmds.Command{
|
||||
Status: cmds.Experimental,
|
||||
Status: cmds.Deprecated,
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "List peers we are currently pubsubbing with.",
|
||||
ShortDescription: `
|
||||
@ -281,7 +281,7 @@ ipfs pubsub peers with no arguments lists out the pubsub peers you are
|
||||
currently connected to. If given a topic, it will list connected peers who are
|
||||
subscribed to the named topic.
|
||||
|
||||
EXPERIMENTAL FEATURE
|
||||
DEPRECATED FEATURE (see https://github.com/ipfs/kubo/issues/9717)
|
||||
|
||||
It is not intended in its current state to be used in a production
|
||||
environment. To use, the daemon must be run with
|
||||
|
||||
@ -8,6 +8,7 @@
|
||||
- [🔦 Highlights](#-highlights)
|
||||
- [Improving the libp2p resource management integration](#improving-the-libp2p-resource-management-integration)
|
||||
- [Addition of "autoclient" router type](#addition-of-autoclient-router-type)
|
||||
- [Deprecation of the `ipfs pubsub` commands and matching HTTP endpoints](#deprecation-of-the-ipfs-pubsub-commands-and-matching-http-endpoints)
|
||||
- [📝 Changelog](#-changelog)
|
||||
- [👨👩👧👦 Contributors](#-contributors)
|
||||
|
||||
@ -28,6 +29,12 @@ A new routing type "autoclient" has been added. This mode is similar to "auto",
|
||||
|
||||
See the [Routing.Type documentation](https://github.com/ipfs/kubo/blob/master/docs/config.md#routingtype) for more information.
|
||||
|
||||
#### Deprecation of the `ipfs pubsub` commands and matching HTTP endpoints
|
||||
|
||||
We are deprecating `ipfs pubsub` and all `/api/v0/pubsub/` RPC endpoints and will remove them in the next release.
|
||||
|
||||
For more information and rational see [#9717](https://github.com/ipfs/kubo/issues/9717).
|
||||
|
||||
### 📝 Changelog
|
||||
|
||||
### 👨👩👧👦 Contributors
|
||||
|
||||
@ -1165,13 +1165,15 @@ Type: `duration`
|
||||
|
||||
## `Pubsub`
|
||||
|
||||
**DEPRECATED**: See [#9717](https://github.com/ipfs/kubo/issues/9717)
|
||||
|
||||
Pubsub configures the `ipfs pubsub` subsystem. To use, it must be enabled by
|
||||
passing the `--enable-pubsub-experiment` flag to the daemon
|
||||
or via the `Pubsub.Enabled` flag below.
|
||||
|
||||
### `Pubsub.Enabled`
|
||||
|
||||
**EXPERIMENTAL:** read about current limitations at [experimental-features.md#ipfs-pubsub](./experimental-features.md#ipfs-pubsub).
|
||||
**DEPRECATED**: See [#9717](https://github.com/ipfs/kubo/issues/9717)
|
||||
|
||||
Enables the pubsub system.
|
||||
|
||||
@ -1181,6 +1183,8 @@ Type: `flag`
|
||||
|
||||
### `Pubsub.Router`
|
||||
|
||||
**DEPRECATED**: See [#9717](https://github.com/ipfs/kubo/issues/9717)
|
||||
|
||||
Sets the default router used by pubsub to route messages to peers. This can be one of:
|
||||
|
||||
* `"floodsub"` - floodsub is a basic router that simply _floods_ messages to all
|
||||
@ -1196,6 +1200,8 @@ Type: `string` (one of `"floodsub"`, `"gossipsub"`, or `""` (apply default))
|
||||
|
||||
### `Pubsub.DisableSigning`
|
||||
|
||||
**DEPRECATED**: See [#9717](https://github.com/ipfs/kubo/issues/9717)
|
||||
|
||||
Disables message signing and signature verification. Enable this option if
|
||||
you're operating in a completely trusted network.
|
||||
|
||||
@ -1209,6 +1215,8 @@ Type: `bool`
|
||||
|
||||
### `Pubsub.SeenMessagesTTL`
|
||||
|
||||
**DEPRECATED**: See [#9717](https://github.com/ipfs/kubo/issues/9717)
|
||||
|
||||
Controls the time window within which duplicate messages, identified by Message
|
||||
ID, will be identified and won't be emitted again.
|
||||
|
||||
@ -1228,6 +1236,8 @@ Type: `optionalDuration`
|
||||
|
||||
### `Pubsub.SeenMessagesStrategy`
|
||||
|
||||
**DEPRECATED**: See [#9717](https://github.com/ipfs/kubo/issues/9717)
|
||||
|
||||
Determines how the time-to-live (TTL) countdown for deduplicating Pubsub
|
||||
messages is calculated.
|
||||
|
||||
|
||||
@ -12,7 +12,6 @@ When you add a new experimental feature to kubo or change an experimental
|
||||
feature, you MUST please make a PR updating this document, and link the PR in
|
||||
the above issue.
|
||||
|
||||
- [ipfs pubsub](#ipfs-pubsub)
|
||||
- [Raw leaves for unixfs files](#raw-leaves-for-unixfs-files)
|
||||
- [ipfs filestore](#ipfs-filestore)
|
||||
- [ipfs urlstore](#ipfs-urlstore)
|
||||
@ -31,36 +30,6 @@ the above issue.
|
||||
|
||||
---
|
||||
|
||||
## ipfs pubsub
|
||||
|
||||
### State
|
||||
|
||||
Candidate, disabled by default but will be enabled by default in 0.6.0.
|
||||
|
||||
### In Version
|
||||
|
||||
0.4.5 (`--enable-pubsub-experiment`)
|
||||
0.11.0 (`Pubsub.Enabled` flag in config)
|
||||
|
||||
### How to enable
|
||||
|
||||
Run your daemon with the `--enable-pubsub-experiment` flag
|
||||
or modify your ipfs config and restart the daemon:
|
||||
```
|
||||
ipfs config --json Pubsub.Enabled true
|
||||
```
|
||||
|
||||
Then use the `ipfs pubsub` commands.
|
||||
|
||||
NOTE: `--enable-pubsub-experiment` CLI flag overrides `Pubsub.Enabled` config.
|
||||
|
||||
Configuration documentation can be found in [kubo/docs/config.md](./config.md#pubsub)
|
||||
|
||||
### Road to being a real feature
|
||||
|
||||
- [ ] Needs to not impact peers who don't use pubsub:
|
||||
https://github.com/libp2p/go-libp2p-pubsub/issues/332
|
||||
|
||||
## Raw Leaves for unixfs files
|
||||
|
||||
Allows files to be added with no formatting in the leaf nodes of the graph.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user