Installing osquery on Linux

A 'universal' Linux package can be created for each package distribution system. These packages contain the osquery daemon, shell, example configuration and startup scripts. Note that the /etc/init.d/osqueryd script does not automatically start the daemon until a configuration file is created (see "Running osquery," below).

Each osquery tag (stable release) is published to yum and apt repositories for our supported operating systems:

The default packages create the following structure:


Note: if building the TGZ "package" with CPack, CMAKE_INSTALL_PREFIX defaults to /usr/local/ rather than /usr/, in all of the paths above. This is also true if installing directly from CMake, e.g., with a make install after compilation. If you plan to use /usr/local/ as the install path prefix, you should also first edit tools/deployment/osqueryd.service. Using one of the packaging systems is recommended, but if you perform an install without using a packaging system, you may also receive the error osqueryd has unsafe permissions: /usr/local/bin/osqueryd, and it will refuse to run. To resolve this, sudo chown root:root /usr/local/bin/osqueryd and its other files.

Installing osquery

To install osquery, follow the instructions on the Downloads page according to your distro.

NOTICE: Linux systems running journald will collect logging data originating from the kernel audit subsystem (something that osquery enables) from several sources, including audit records. To avoid performance problems on busy boxes (specially when osquery event tables are enabled), it is recommended to mask audit logs from entering the journal with the following command systemctl mask --now systemd-journald-audit.socket.

Running osquery

To start a standalone osquery use: osqueryi. This does not need an osquery server or service. All the table implementations are included!

After exploring the rest of the documentation you should understand the basics of configuration and logging. These and most other concepts apply to osqueryd, the daemon, too. To start the daemon:

sudo cp /usr/share/osquery/osquery.example.conf /etc/osquery/osquery.conf
# sudo service osqueryd start
sudo systemctl start osqueryd

NOTICE: The interactive shell and daemon do NOT communicate!