From 9b1d32b78dcc2389b0889e4b8d7cfdd649f559e3 Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Tue, 20 Jun 2023 17:44:11 +0200 Subject: [PATCH] docs: add explaination on how to change home folder globaly (backport #16620) (#16622) Co-authored-by: Julien Robert --- docs/docs/run-node/01-run-node.md | 7 ++++++- tools/confix/cmd/home.go | 3 ++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/docs/run-node/01-run-node.md b/docs/docs/run-node/01-run-node.md index 64300b4a00..59c022c3b7 100644 --- a/docs/docs/run-node/01-run-node.md +++ b/docs/docs/run-node/01-run-node.md @@ -30,7 +30,12 @@ Before actually running the node, we need to initialize the chain, and most impo simd init --chain-id my-test-chain ``` -The command above creates all the configuration files needed for your node to run, as well as a default genesis file, which defines the initial state of the network. All these configuration files are in `~/.simapp` by default, but you can overwrite the location of this folder by passing the `--home` flag. +The command above creates all the configuration files needed for your node to run, as well as a default genesis file, which defines the initial state of the network. + +:::tip +All these configuration files are in `~/.simapp` by default, but you can overwrite the location of this folder by passing the `--home` flag to each commands, +or set an `$APPD_HOME` environment variable (where `APPD` is the name of the binary). +::: The `~/.simapp` folder has the following structure: diff --git a/tools/confix/cmd/home.go b/tools/confix/cmd/home.go index 21ecdb3884..5748160296 100644 --- a/tools/confix/cmd/home.go +++ b/tools/confix/cmd/home.go @@ -8,7 +8,8 @@ import ( func HomeCommand() *cobra.Command { return &cobra.Command{ Use: "home", - Short: "Outputs the string being used as the home path. No home directory is set when using the tool standalone.", + Short: "Outputs the folder used as the binary home. No home directory is set when using the tool standalone.", + Long: `Outputs the folder used as the binary home. In order to change the home directory path, set the $APPD_HOME environment variable, or use the "--home" flag.`, Args: cobra.NoArgs, Run: func(cmd *cobra.Command, args []string) { clientCtx := client.GetClientContextFromCmd(cmd)