mandiant / capa

The FLARE team's open-source tool to identify capabilities in executable files.
Apache License 2.0
3.99k stars 499 forks source link

Research and briefly document deployment of github.io page #2088

Closed mr-tz closed 4 days ago

mr-tz commented 1 month ago

We are considering deploying a capa results rendering website. Let's research and document how this can be done via githhub.io pages (deployment, updates, etc.).

mr-tz commented 1 week ago

via @williballenthin

As previously discussed, we will use Github Pages to deploy capa's website(s). While there are a couple ways to set this up, you should think of it like this:

  1. we push static web content (HTML, CSS, JS, images) or markdown to a branch of the capa repository.
  2. Github actions puts the static content on Github's servers.
  3. the content becomes accessible at https://mandiant.github.io/capa

There are all sorts of details to discuss and decide on, like static website generators, frameworks, styling, and how the webui integrates with the capa-rules website, but we can address those as needed. This is just to confirm that GH Pages should work well for us.

As an example, I configured GH pages to continuously publish the branch pages (which right now is just a snapshot of master) and you can see our readme is now served at our URL: https://mandiant.github.io/capa/

s-ff commented 1 week ago

The build system vite provides documentation on deploying a static site to Github Pages and provides a deploymenet template workflow.

mr-tz commented 1 week ago

Cool, should be straightforward then to add this.

s-ff commented 4 days ago

@mr-tz As I mentioned above, the provided template for deployment works as intended for our case. See example here. You can find the workflow source here. The live site would be <username>.github.io/<repo-name>/