CONFIG.md

Config API

• ipfs.config.get(key, [options])
  • Parameters
  • Options
  • Returns
  • Example
• ipfs.config.getAll([options])
  • Options
  • Returns
  • Example
• ipfs.config.set(key, value, [options])
  • Parameters
  • Options
  • Returns
  • Example
• ipfs.config.replace(config, [options])
  • Parameters
  • Options
  • Returns
  • Example
• ipfs.config.profiles.list([options])
  • Parameters
  • Options
  • Returns
  • Example
• ipfs.config.profiles.apply(name, [options])
  • Parameters
  • Options
  • Returns
  • Example

ipfs.config.get(key, [options])

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

Parameters

Name	Type	Description
key	String	The key of the value that should be fetched from the config file.

Options

An optional object which may have the following keys:

Name	Type	Default	Description
timeout	Number	undefined	A timeout in ms
signal	AbortSignal	undefined	Can be used to cancel any long running requests started as a result of this call

Returns

Type	Description
Promise<Object>	An object containing the configuration of the IPFS node

Example

const config = await ipfs.config.get()
console.log(config)

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

ipfs.config.getAll([options])

Returns the full config been used. If the daemon is off, it returns the stored config.

Options

An optional object which may have the following keys:

Name	Type	Default	Description
timeout	Number	undefined	A timeout in ms
signal	AbortSignal	undefined	Can be used to cancel any long running requests started as a result of this call

Returns

Type	Description
Promise<Object>	An object containing the configuration of the IPFS node

Example

const config = await ipfs.config.getAll()
console.log(config)

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

ipfs.config.set(key, value, [options])

Adds or replaces a config value.

Parameters

Name	Type	Description
key	String	The key of the value that should be added or replaced
value	any	The value to be set

Options

An optional object which may have the following keys:

Name	Type	Default	Description
timeout	Number	undefined	A timeout in ms
signal	AbortSignal	undefined	Can be used to cancel any long running requests started as a result of this call

Returns

Type	Description
Promise<void>	If action is successfully completed. Otherwise an error will be thrown

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

await ipfs.config.set('Discovery.MDNS.Enabled', false)
// MDNS Discovery was set to false

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

ipfs.config.replace(config, [options])

Adds or replaces a config file

Parameters

Name	Type	Description
config	Object	An object that contains the new config

Options

An optional object which may have the following keys:

Name	Type	Default	Description
timeout	Number	undefined	A timeout in ms
signal	AbortSignal	undefined	Can be used to cancel any long running requests started as a result of this call

Returns

Type	Description
Promise<void>	If action is successfully completed. Otherwise an error will be thrown

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

const newConfig = {
  Bootstrap: []
}

await ipfs.config.replace(newConfig)
// config has been replaced

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

ipfs.config.profiles.list([options])

List available config profiles

Parameters

None

Options

An optional object which may have the following keys:

Name	Type	Default	Description
timeout	Number	undefined	A timeout in ms
signal	AbortSignal	undefined	Can be used to cancel any long running requests started as a result of this call

Returns

Type	Description
Promise<Array>	An array with all the available config profiles

Example

const profiles = await ipfs.config.profiles.list()
profiles.forEach(profile => {
  console.info(profile.name, profile.description)
})

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

ipfs.config.profiles.apply(name, [options])

Apply a config profile

Parameters

Name	Type	Description
name	String	The name of the profile to apply

Call config.profiles.list() for a list of valid profile names.

Options

An optional object which may have the following keys:

Name	Type	Default	Description
dryRun	boolean	false	If true does not apply the profile
timeout	Number	undefined	A timeout in ms
signal	AbortSignal	undefined	Can be used to cancel any long running requests started as a result of this call

Returns

Type	Description
Promise<Object>	An object containing both the original and updated config

Example

const diff = await ipfs.config.profiles.apply('lowpower')
console.info(diff.original)
console.info(diff.updated)

Note that you will need to restart your node for config changes to take effect.

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