Skip to content

Commit 5167feb

Browse files
authored
[docs] Indicate that SYSTEM user is required on Windows to use Endpoint (#20172) (#20209)
1 parent 8f1b2e2 commit 5167feb

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

x-pack/elastic-agent/docs/elastic-agent.asciidoc

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ To learn how to install, configure, and run your {agent}s, see:
1515

1616
* <<elastic-agent-installation>>
1717
* <<run-elastic-agent>>
18+
* <<stop-elastic-agent>>
1819
* <<elastic-agent-cmd-options>>
1920
* <<elastic-agent-configuration>>
2021

x-pack/elastic-agent/docs/run-elastic-agent.asciidoc

+9-5
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,18 @@ generate a token. See <<ingest-management-getting-started>> for detailed steps.
3434
+
3535
Where `$token` is an enrollment token acquired from {fleet}.
3636

37+
//TODO: Add tabbed panels for platform-specific tabs (waiting for final design)
38+
3739
To start {agent}, run:
40+
41+
// tag::run-agent[]
3842
[source,shell]
3943
----
40-
./elastic-agent run
44+
./elastic-agent run <1>
4145
----
46+
<1> On Windows, you must run {agent} under the SYSTEM account if you plan
47+
to use the {elastic-endpoint} integration.
48+
// end::run-agent[]
4249

4350
[discrete]
4451
[[standalone-mode]]
@@ -52,10 +59,7 @@ when you restart your system.
5259

5360
To start {agent} manually, run:
5461

55-
[source,shell]
56-
----
57-
./elastic-agent run
58-
----
62+
include::run-elastic-agent.asciidoc[tag=run-agent]
5963

6064
If no configuration file is specified, {agent} uses the default configuration,
6165
`elastic-agent.yml`, which is located in the same directory as {agent}. Specify

0 commit comments

Comments
 (0)