Skip to content

Latest commit

 

History

History
95 lines (60 loc) · 2.72 KB

CONFIG.md

File metadata and controls

95 lines (60 loc) · 2.72 KB
Raw

Config API

config.get

Returns the currently being used config. If the daemon is off, it returns the stored config.

Go WIP
JavaScript - ipfs.config.get([key, callback])

key is the key of the value that should be fetched from the config file. If no key is passed, then the whole config should be returned. key should be of type String.

callback must follow function (err, config) {} signature, where err is an error if the operation was not successful and config is a JSON object containing the configuration of the IPFS node.

If no callback is passed, a promise is returned

Example:

ipfs.config.get((err, config) => {
  if (err) {
    throw err
  }
  console.log(config)
})

A great source of examples can be found in the tests for this API.

config.set

Adds or replaces a config value.

Go WIP
JavaScript - ipfs.config.set(key, value, [callback])

key is the key value that will be added or replaced (in case of the value already). key should be of type String.

value value to be set.

callback must follow function (err) {} signature, where err is an error if the operation was not successful.

If no callback is passed, a promise is returned

Note that this operation will not spark the restart of any service, i.e: if a config.replace changes the multiaddrs of the Swarm, Swarm will have to be restarted manually for the changes to take difference.

Example:

ipfs.config.set('Discovery.MDNS.Enabled', false, (err) => {
  if (err) {
    throw err
  }
  // MDNS Discovery was set to false
})

A great source of examples can be found in the tests for this API.

config.replace

Adds or replaces a config file.

Go WIP
JavaScript - ipfs.config.replace(config, [callback])

config is a JSON object that contains the new config.

callback must follow function (err) {} signature, where err is an error if the operation was not successful.

If no callback is passed, a promise is returned

Note that this operation will not spark the restart of any service, i.e: if a config.replace changes the multiaddrs of the Swarm, Swarm will have to be restarted manually for the changes to take difference.

Example:

ipfs.config.replace(newConfig, (err) => {
  if (err) {
    throw err
  }
  // config has been replaced
})

A great source of examples can be found in the tests for this API.