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.

Sign up for GitHub

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

Jump to bottom

Update configure-node.md #1082

Merged
merged 1 commit into from
Mar 17, 2022
Merged

Update configure-node.md #1082

merged 1 commit into from
Mar 17, 2022

Conversation

Annamarie2019
Copy link
Contributor

Clarifies definition of pubsub .

@lidel should we give this here too:

To use this feature, use Ipns.UsePubsub before starting the IPFS daemon:

ipfs config --json Ipns.UsePubsub true
ipfs daemon

@Annamarie2019
Update configure-node.md
75ded70 
Clarifies enabling `pubsub` .
@filecorgi
Copy link
Contributor

  • Image optimization came back clean!
  • Vuepress build was successful!

docs/how-to/configure-node.md:

  • If a new sentence starts here, add a space and start with an uppercase letter. 
    ...es to be used by this node. # Addresses.API Multiaddr or array of multiaddrs...
                                           ^^^
  • Do you wish to insert an arrow? 
    ...mple: Default: null Type: object[string -> array[string]] (header names -> a...
                                           ^^
  • Do you wish to insert an arrow? 
    ...[string -> array[string]] (header names -> array of header values) # AutoNAT...
                                           ^^
  • The verb after “to” should be in the base form. 
    ...fault), the AutoNAT service defaults to enabled. Otherwise, this field can t...
                                           ^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ... for the above limits. Default: 1m0s (1 Minute) Type: duration (when set to ...
                                           ^^^^^^
  • Consider a shorter alternative to avoid wordiness. 
    ...ltiaddrs of trusted nodes to connect to in order to initiate a connection to...
                                           ^^^^^^^^^^^
  • Possible missing comma found. 
    ...the on-disk storage system. # Datastore.StorageMax A soft upper limit for th...
                                           ^^^^^^^^^^
  • Insert a space between the numerical value and the unit symbol. 
    ... if --enable-gc flag is set). Default: "10GB" Type: string (size) # Datastor...
                                           ^^^^
  • Possible missing comma found. 
    ...use increased CPU utilization. Default: false Type: bool # Datastore.BloomFi...
                                           ^^^^^
  • Possible missing comma found. 
    .... Default: false Type: bool # Datastore.BloomFilterSize A number representin...
                                           ^^^^^^^^^^^^^^^
  • Possible missing comma found. 
    ... in bits. Remember to convert the value m from bits, into bytes for use as B...
                                           ^
  • The abbreviation “e.g.” (= for example) requires two periods. 
    ...astores to provide extra functionality (eg metrics, logging, or caching). Th...
                                           ^^
  • Consider shortening this phrase to just “whether”. It is correct though if you mean ‘regardless of whether’. 
    ...covery.MDNS.Enabled A boolean value for whether or not mdns should be active...
                                           ^^^^^^^^^^^^^^
  • Possible missing comma found. 
    ... fetch files from the network. Default: false Type: bool # Gateway.NoDNSLink...
                                           ^^^^^
  • Possible missing comma found. 
    ...rk. Default: false Type: bool # Gateway.NoDNSLink A boolean to configure whe...
                                           ^^^^^^^^^
  • Possible missing article found. 
    ...ld be performed. If DNSLink is present, content path stored in the DNS TXT r...
                                           ^^^^^^^
  • Possible missing article found. 
    ...in the DNS TXT record becomes the / and respective payload is returned to th...
                                           ^^^^^^^^^^
  • Do you wish to insert an arrow? 
    ...responses. Default: Type: object[string -> array[string]] # Gateway.RootRedi...
                                           ^^
  • Possible missing comma found. 
    ...ject[string -> array[string]] # Gateway.RootRedirect A url to redirect reque...
                                           ^^^^^^^^^^^^
  • Possible missing comma found. 
    ...efault: "" Type: string (url) # Gateway.Writable A boolean to configure whet...
                                           ^^^^^^^^
  • Possible missing comma found. 
    ...e gateway is writeable or not. Default: false Type: bool # Gateway.PathPrefi...
                                           ^^^^^
  • Did you mean “mount a blog”? 
    ...tend http proxy like nginx. Example: We mount blog.ipfs.io (a dnslink page) ...
                                           ^^^^^^^^^^
  • Possible missing comma found. 
    ...se Type: bool # Gateway.PublicGateways: NoDNSLink A boolean to configure whe...
                                           ^^^^^^^^^
  • Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. 
    ...se proxy that provides TLS, make it add a X-Forwarded-Proto: https HTTP head...
                                           ^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...of the box unless set to true manually) Hardened, site-specific DNSLink gate...
                                           ^^^^^^^^
  • Possible missing comma found. 
    ...oDNSLink": true,  # Identity # Identity.PeerID The unique PKI identity label...
                                           ^^^^^^
  • The demonstrative ‘this’ may not agree with the plural noun ‘configs’. Did you mean “these”? 
    ...eerID The unique PKI identity label for this configs peer. Set on init and n...
                                           ^^^^
  • Possible missing comma found. 
    ...time. Type: string (peer ID) # Identity.PrivKey The base64 encoded protobuf ...
                                           ^^^^^^^
  • It seems likely that a singular genitive (’s) apostrophe is missing. 
    ...rotobuf describing (and containing) the nodes private key. Type: string (bas...
                                           ^^^^^
  • Possible missing comma found. 
    ...: string (base64 encoded) # Ipns # Ipns.RepublishPeriod A time duration spec...
                                           ^^^^^^^^^^^^^^^
  • Possible missing comma found. 
    ...an empty string for the default. # Ipns.RecordLifetime A time duration speci...
                                           ^^^^^^^^^^^^^^
  • If this is a compound adjective that modifies the following noun, use a hyphen. 
    ...for managing that service's interest in longer term data storage. The expose...
                                           ^^^^^^^^^^^
  • Possible missing comma found. 
    ...elevant to utilizing the remote pinning service Example: # Pinning.RemoteSer...
                                           ^^^^^^^
  • ‘cafes’ is an imported foreign name or expression, which originally has a diacritic. 
    ...th a set of pinning services or textile cafes/hubs. A set of friends may pee...
                                           ^^^^^
  • Did you mean “very”? 
    ...tected by both nodes and will likely be vary stable. When asymmetric, only o...
                                           ^^^^
  • Possible missing comma found. 
    ...eering to not overload peers. # Peering.Peers The set of peers with which to...
                                           ^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...e: array[peering] # Reprovider.Strategy Tells reprovider what should be anno...
                                           ^^^^^
  • Style-wise, it’s not ideal to insert an adverb (‘explicitly’) in the middle of an infinitive construction (‘to connect’). Try moving the adverb to avoid split infinitives. 
    ...node will use no routing system. You'll have to explicitly connect to peers ...
                                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...source intensive than server mode. When Routing.Type is set to dht, your nod...
                                           ^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...pecific DHT mode, client or server, set Routing.Type to dhtclient or dhtserv...
                                           ^^^^^^^
  • Possible missing comma found. 
    ...erver, set Routing.Type to dhtclient or dhtserver respectively. Please do no...
                                           ^^^^^^^^^
  • Possible missing comma found. 
    ...ions for configuring the swarm. # Swarm.AddrFilters An array of addresses (m...
                                           ^^^^^^^^^^^
  • Possible missing comma found. 
    ...DisableBandwidthMetrics A boolean value that when set to true, will cause ip...
                                           ^^^^
  • Possible missing comma found. 
    ...s a reduction in memory usage. Default: false Type: bool # Swarm.DisableNatP...
                                           ^^^^^
  • Possible missing comma found. 
    ...ible from the public internet. Default: false Type: bool # Swarm.DisableRela...
                                           ^^^^^
  • Possible missing comma found. 
    ...ions from nodes behind relays. Default: false Type: bool # Swarm.EnableRelay...
                                           ^^^^^
  • The preposition ‘to’ seems more likely in this position. 
    ...lay "hop". A relay "hop" relays traffic for other peers. WARNING: Do not ena...
                                           ^^^
  • Possible missing comma found. 
    ...th. There is no rate-limiting. Default: false Type: bool # Swarm.EnableAutoR...
                                           ^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...If Swarm.EnableAutoRelay is enabled and Swarm.EnableRelayHop is disabled, yo...
                                           ^^^^^
  • Possible missing comma found. 
    ...same time. # Swarm.EnableAutoNATService REMOVED Please use [AutoNAT.ServiceM...
                                           ^^^^^^^
  • Consider adding a comma here. 
    ...me. # Swarm.EnableAutoNATService REMOVED Please use [AutoNAT.ServiceMode][]....
                                           ^^^^^^^
  • Possible typo detected. 
    ...rm.Transports Configuration section for libp2p transports. An empty configur...
                                           ^^^^^^
  • Possible typo detected. 
    ...ports.Network Configuration section for libp2p network transports. Transport...
                                           ^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...s for these transports must be added to Addresses.Swarm. Supported transport...
                                           ^^^^^^^^^
  • Possible typo detected. 
    ...port encryption and/or multiplexing, so libp2p will layer a security & multi...
                                           ^^^^^^
  • Possible typo detected. 
    ...fault) # Swarm.Transports.Network.Relay Libp2p Relay  (opens new window) pro...
                                           ^^^^^^
  • Possible typo detected. 
    ...connections by hopping between multiple libp2p nodes. This transport is prim...
                                           ^^^^^^
  • Possible typo detected. 
    ...orts.Security Configuration section for libp2p security transports. Transpor...
                                           ^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ... SECIO (Disabled: i.e. priority false), Noise (priority 300). No default pri...
                                           ^^^^^
  • Possible typo detected. 
    ...w) was the most widely supported IPFS & libp2p security transport. However, ...
                                           ^^^^^^
  • Possible missing comma found. 
    ... protocols like TLS and Noise. Default: false Type: priority # Swarm.Transpo...
                                           ^^^^^
  • Possible typo detected. 
    ...lace TLS as the cross-platform, default libp2p protocol due to ease of imple...
                                           ^^^^^^
  • Possible typo detected. 
    ....Multiplexers Configuration section for libp2p multiplexer transports. Trans...
                                           ^^^^^^
  • Possible typo detected. 
    ... between go-ipfs and all other IPFS and libp2p implementations. Unlike Yamux...
                                           ^^^^^^
  • The verb form ‘specifies’ does not seem to match the subject ‘values’. 
    ... Unlike Yamux: The mounts config values specifies the default mount points f...
                                           ^^^^^^^^^

@johnnymatthews johnnymatthews merged commit e36fb50 into main Mar 17, 2022
@johnnymatthews johnnymatthews deleted the Annamarie2019-patch-3 branch March 17, 2022 17:31
@lidel
Copy link
Member

lidel commented Mar 23, 2022

fwiw i filled #1088 to stop having to update this manually – feedback on that PR is appreciated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@johnnymatthews johnnymatthews johnnymatthews approved these changes

@lidel lidel Awaiting requested review from lidel

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Annamarie2019 @filecorgi @lidel @johnnymatthews