Skip to content

Commit

Permalink
Added clarification about 'any' and OS X. Fixes elastic#50.
Browse files Browse the repository at this point in the history
  • Loading branch information
Tudor Golubenco committed May 22, 2015
1 parent a4ff27d commit fbaf386
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
10 changes: 7 additions & 3 deletions docs/gettingstarted.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,9 @@ Before starting the shipper, edit the configuration file. For rpm and deb the
configuration file is `/etc/packetbeat/packetbeat.yml`. For mac the
configuration file is found in the archive you just downloaded.
First, select the network interface from which to capture the traffic. Packetbeat
supports capturing all messages sent or received by the server on which it is
installed. For this, use `any` as the device:
First, select the network interface from which to capture the traffic. On
Linux, Packetbeat supports capturing all messages sent or received by the
server on which it is installed. For this, use `any` as the device:
[source,yaml]
----------------------------------------------------------------------
Expand All @@ -147,6 +147,10 @@ interfaces:
device: any
----------------------------------------------------------------------
Note that on OS X, capturing from the `any` device doesn't work. You would
typically use either `lo0` or `en0` depending on which traffic you want to
capture.
In the next section, configure the ports on which Packetbeat can find each
protocol. If you use any non-standard ports, add them here. Otherwise, the
default values should do just fine.
Expand Down
10 changes: 7 additions & 3 deletions docs/gettingstarted.in.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,9 @@ Before starting the shipper, edit the configuration file. For rpm and deb the
configuration file is `/etc/packetbeat/packetbeat.yml`. For mac the
configuration file is found in the archive you just downloaded.

First, select the network interface from which to capture the traffic. Packetbeat
supports capturing all messages sent or received by the server on which it is
installed. For this, use `any` as the device:
First, select the network interface from which to capture the traffic. On
Linux, Packetbeat supports capturing all messages sent or received by the
server on which it is installed. For this, use `any` as the device:

[source,yaml]
----------------------------------------------------------------------
Expand All @@ -138,6 +138,10 @@ interfaces:
device: any
----------------------------------------------------------------------

Note that on OS X, capturing from the `any` device doesn't work. You would
typically use either `lo0` or `en0` depending on which traffic you want to
capture.

In the next section, configure the ports on which Packetbeat can find each
protocol. If you use any non-standard ports, add them here. Otherwise, the
default values should do just fine.
Expand Down

0 comments on commit fbaf386

Please sign in to comment.