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

1.3 KiB Raw Blame History