Skip to content

Commit

Permalink
Improve agent uninstall docs to ensure correct directory (#796) (#797)
Browse files Browse the repository at this point in the history
(cherry picked from commit 812e9b0)

Co-authored-by: David Kilfoyle <[email protected]>
  • Loading branch information
mergify[bot] and kilfoyle committed Jan 5, 2024
1 parent 7edc1a7 commit 34effe2
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
12 changes: 12 additions & 0 deletions docs/en/ingest-management/commands.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -894,6 +894,18 @@ Permanently uninstall {agent} from the system.
You must run this command as the root user (or Administrator on Windows)
to remove files.

[IMPORTANT]
====
Be sure to run the `uninstall` command from the directory where {agent} is installed and not from the directory where you previously ran the `install` command.
--
include::{tab-widgets}/uninstall-widget.asciidoc[]
--
====

[discrete]
=== Synopsis

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
== Uninstall on macOS, Linux, and Windows

To uninstall {agent}, run the `uninstall` command from the directory where
{agent} is running:
{agent} is running.

IMPORTANT: Be sure to run the `uninstall` command from the directory where {agent} is running, as shown in the example below, and not from the directory where you previously ran the `install` command. Running the command from the wrong directory can leave the agent in an inconsistent state.

--
include::{tab-widgets}/uninstall-widget.asciidoc[]
Expand Down

0 comments on commit 34effe2

Please sign in to comment.