Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cherry-pick to 7.x: [docs] Indicate that SYSTEM user is required on Windows to use Endpoint (#20172) #20210

Merged
merged 1 commit into from
Jul 23, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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