The osquery website was written in js some time ago. It is not under active develelopment, and parts may be getting quite flakey.
The website is hosted on GitHub pages. It is deployed there using GitHub actions. As of 2025, this follows a normal github flow -- development on feature branches, PR to main. The deploy-to-pages happens on merge to main.
In front of GitHub Pages is AWS Cloudfront. This is in the infra account. We should probably migrate off it.
When debugging, be aware of a bit of a weirdness -- pages deploys to https://osquery.github.io/osquery-site/ but that URL won't work, because several parts of the website generate absolute URLs rooted in /. This is okay behind the CDN though.
Install all dependencies:
yarn
Run the app:
yarn start
The app should open in a browser window at http://localhost:3000.
Before submitting a PR, please lint:
yarn lint
Storybook is a UI development environment that allows us to view the app's components in isolation. To start Storybook, open another terminal and run
yarn storybook
The Storybook application will be viewable at http://localhost:9001.
The textual content for each page can be found at /src/data/pages.
The osquery schema data can be found at /src/data/osquery_schema_versions.
To upload a new blog post, please submit a PR with a markdown file to either official news or community articles.
If you would like to upload an image for your blog post, please do the following:
- Add the image to the blog post images directory.
- Import the image in the images manifest, and give your image a unique reference name.
- Insert the image in your markdown as you typically would, but instead of the file path use the reference name from the manifest. i.e.
.
To upload a new community event, submit a PR adding a JSON file to the community events directory. Please include the following information in the listing:
{
"title": [string],
"location": [string],
"startYear": [number],
"startMonth": [number],
"startDay": [number],
"endYear": [number], // optional
"endMonth": [number], // optional
"endDay": [number] // optional
"url": [string] // optional
}
Additionally, please add the newly-added filename to the manifest file.
This repository is licensed under the terms of the Creative Commons 4.0 International (Documentation License). See LICENSE-DOCUMENTATION for the full terms of the license.