Skip to content

Commit

Permalink
[docs] Indicate that SYSTEM user is required on Windows to use Endpoi…
Browse files Browse the repository at this point in the history
…nt (#20172) (#20209)
  • Loading branch information
dedemorton authored Jul 23, 2020
1 parent 8f1b2e2 commit 5167feb
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
1 change: 1 addition & 0 deletions x-pack/elastic-agent/docs/elastic-agent.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ To learn how to install, configure, and run your {agent}s, see:

* <<elastic-agent-installation>>
* <<run-elastic-agent>>
* <<stop-elastic-agent>>
* <<elastic-agent-cmd-options>>
* <<elastic-agent-configuration>>

Expand Down
14 changes: 9 additions & 5 deletions x-pack/elastic-agent/docs/run-elastic-agent.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,18 @@ generate a token. See <<ingest-management-getting-started>> 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]]
Expand All @@ -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
Expand Down

0 comments on commit 5167feb

Please sign in to comment.