diff --git a/core/commands/config.go b/core/commands/config.go index 92acf4d2aaa4..e2b08be3d942 100644 --- a/core/commands/config.go +++ b/core/commands/config.go @@ -330,7 +330,7 @@ var configProfileApplyCmd = &cmds.Command{ var configProfileRevertCmd = &cmds.Command{ Helptext: cmdkit.HelpText{ Tagline: "Revert profile changes.", - ShortDescription: `Reverts profile-related changes to the config. + ShortDescription: `Reverts profile-related changes to the default values. Reverting some profiles may damage the configuration or not be possible. Backing up the config before running this command is advised.`, diff --git a/docs/config.md b/docs/config.md index 99f62de40c0a..bb8dc5ca3251 100644 --- a/docs/config.md +++ b/docs/config.md @@ -9,14 +9,27 @@ Configuration profiles allow to tweak configuration quickly. Profiles can be applied with `--profile` flag to `ipfs init` or with `ipfs config profile apply` command. -- `server` profile -Recommended for nodes with public IPv4 address, disables host and content -discovery in local networks. - -- `test` profile -Reduces external interference, useful for running ipfs in test environments. -Note that with these settings node won't be able to talk to the rest of the -network without manual bootstrap. +Available profiles: +- `server` + + Recommended for nodes with public IPv4 address, disables host and content + discovery in local networks. + +- `test` + + Reduces external interference, useful for running ipfs in test environments. + Note that with these settings node won't be able to talk to the rest of the + network without manual bootstrap. + +- `badgerds` + + Replaces default datastore configuration with experimental badger datastore. + If you apply this profile after `ipfs init`, you will need to convert your + datastore to the new configuration. You can do this using [ipfs-ds-convert](https://github.com/ipfs/ipfs-ds-convert) + + WARNING: badger datastore is experimantal. Make sure to backup your data + frequently + ## Table of Contents