osquery-1/site
mike@arpaia.co b9f732c31f Updating the license comment to be the correct open source header
As per t5494224, all of the license headers in osquery needed to be updated
to reflect the correct open source header style.
2014-12-18 10:52:55 -08:00
..
assets [site] Add tables API page 2014-11-05 02:19:20 -08:00
src Updating the license comment to be the correct open source header 2014-12-18 10:52:55 -08:00
vendor [site] Add tables API page 2014-11-05 02:19:20 -08:00
.gitignore static site 2014-10-05 04:50:40 -07:00
build.js Updating the license comment to be the correct open source header 2014-12-18 10:52:55 -08:00
client.js Updating the license comment to be the correct open source header 2014-12-18 10:52:55 -08:00
package.json static site 2014-10-05 04:50:40 -07:00
README.md site instructions [skip ci] 2014-11-05 12:14:40 -08:00
server.js Updating the license comment to be the correct open source header 2014-12-18 10:52:55 -08:00

osquery website

This website is single page app built on React, with styles and structure taken from the Bootstrap docs website. The app is statically generated to HTML via node and then hosted it by pushing HTML to GitHub Pages.

Installation

If you are working on the site, you will want to install and run a local copy of it.

Dependencies

All dependencies are installed with npm, just:

$ npm install

Instructions

Development

Once you've installed the project's dependencies via npm install, simply start the app:

$ npm start
$ open http://localhost:4000/

This will start an express based node server which will generate static html content and the js bundle on request. After making any modifications the server should restart and regenerate any necessary files on the next request.

Production

This site is statically published on github pages, to do this the static HTML needs to be generated.

$ npm start
$ cd /tmp
$ wget -r localhost:4000
$ cd ~/git/osquery # or where ever you have osquery checked out
$ git checkout gh-pages
$ mv /tmp/localhost:4000/* ./
$ git commit -am "site updates"
$ git push origin gh-pages