valitydev/osquery-1
14
0
Fork 0
mirror of https://github.com/valitydev/osquery-1.git synced 2024-11-07 01:55:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

explicitly call out OS compatibility at top of OS X install doc

Browse Source 
Reordered install types, Pointed to the CI build status as an indication
of platform support, moved up the line about pkg/lib dependencies
to be after the pkg section. Someone stop Atom from tacking newlines to
the ends of files on save, GitHub, you’re not the boss of me!
This commit is contained in:
Allister Banks 2015-10-13 14:04:51 -04:00
parent 34717fda29
commit d79d02dde5
1 changed files with 29 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
docs/wiki/installation/install-osx.md
View File

@ -1,4 +1,32 @@
## Homebrew
### Supported OS Versions
Continuous integration currently tests stable release versions of osquery against 10.9 and 10.10 (as listed under the _Build_status_ column on the project [README](https://github.com/facebook/osquery/blob/master/README.md)). There are no reported issues which block expected core functionality on 10.11.
Each tagged release of osquery may be installed on all versions of OS X.
## Package Installation
If you plan to manage an enterprise osquery deployment, the easiest installation method is an OS X package installer. You would have to manage and deploy updates, but there are no libraries required or other dependencies.
Each osquery tag (release) builds an OS X package:
[osquery.io/downloads](https://osquery.io/downloads/).
The default package creates the following structure:
```sh
/private/var/osquery/com.facebook.osqueryd.plist
/private/var/osquery/osquery.example.conf
/private/var/log/osquery/
/private/var/osquery/packs/
/usr/local/lib/osquery/
/usr/local/bin/osqueryctl
/usr/local/bin/osqueryd
/usr/local/bin/osqueryi
```
This package does NOT install a LaunchDaemon to start osqueryd. You may use the `osqueryctl` script to copy the sample launch daemon job plist and associated configuration into place.
## Homebrew Installation
The easiest way to install osquery on OS X is via Homebrew. Check the [Homebrew](http://brew.sh/) homepage for installation instructions.
@ -16,30 +44,6 @@ $ brew update
$ brew upgrade osquery
```
## OS X Package
If you plan to manage an enterprise osquery deployment, the easiest installation method is
an OS X package installer. You will have to manage and deploy updates.
Each osquery tag (release) builds an OS X package:
[osquery.io/downloads](https://osquery.io/downloads/).
There are no package or library dependencies.
The default package creates the following structure:
```sh
/private/var/osquery/com.facebook.osqueryd.plist
/private/var/osquery/osquery.example.conf
/private/var/log/osquery/
/private/var/osquery/packs/
/usr/local/lib/osquery/
/usr/local/bin/osqueryctl
/usr/local/bin/osqueryd
/usr/local/bin/osqueryi
```
This package does NOT install a LaunchDaemon to start osqueryd. You may use the `osqueryctl` script to install the sample launch daemon script.
## Running osquery
To start a standalone osquery use: `$ osqueryi`. This does not need a server or service. All the table implementations are included!