From a6923c26eba1fc03e7940e9251a6eca72f00de80 Mon Sep 17 00:00:00 2001 From: DeDe Morton Date: Thu, 23 Jul 2020 08:36:50 -0700 Subject: [PATCH] [docs] Indicate that SYSTEM user is required on Windows to use Endpoint (#20172) --- x-pack/elastic-agent/docs/elastic-agent.asciidoc | 1 + .../elastic-agent/docs/run-elastic-agent.asciidoc | 14 +++++++++----- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/x-pack/elastic-agent/docs/elastic-agent.asciidoc b/x-pack/elastic-agent/docs/elastic-agent.asciidoc index 89212cea67e..a3736a8e944 100644 --- a/x-pack/elastic-agent/docs/elastic-agent.asciidoc +++ b/x-pack/elastic-agent/docs/elastic-agent.asciidoc @@ -15,6 +15,7 @@ To learn how to install, configure, and run your {agent}s, see: * <> * <> +* <> * <> * <> diff --git a/x-pack/elastic-agent/docs/run-elastic-agent.asciidoc b/x-pack/elastic-agent/docs/run-elastic-agent.asciidoc index e7f3896d551..9cc31bfc44a 100644 --- a/x-pack/elastic-agent/docs/run-elastic-agent.asciidoc +++ b/x-pack/elastic-agent/docs/run-elastic-agent.asciidoc @@ -34,11 +34,18 @@ generate a token. See <> for detailed steps. + Where `$token` is an enrollment token acquired from {fleet}. +//TODO: Add tabbed panels for platform-specific tabs (waiting for final design) + To start {agent}, run: + +// tag::run-agent[] [source,shell] ---- -./elastic-agent run +./elastic-agent run <1> ---- +<1> On Windows, you must run {agent} under the SYSTEM account if you plan +to use the {elastic-endpoint} integration. +// end::run-agent[] [discrete] [[standalone-mode]] @@ -52,10 +59,7 @@ when you restart your system. To start {agent} manually, run: -[source,shell] ----- -./elastic-agent run ----- +include::run-elastic-agent.asciidoc[tag=run-agent] If no configuration file is specified, {agent} uses the default configuration, `elastic-agent.yml`, which is located in the same directory as {agent}. Specify