Skip to content

Latest commit

 

History

History
63 lines (54 loc) · 2.86 KB

README.md

File metadata and controls

63 lines (54 loc) · 2.86 KB

GUFI Documentation

This directory contains documentation on what GUFI is, how this repository is structured, how to build GUFI, and how to run GUFI.

Design Documentation

Documentation on the design of GUFI can be found at GUFI.docx and in the Supercomputing 2022 paper:

Dominic Manno, Jason Lee, Prajwal Challa, Qing Zheng, David Bonnie, Gary Grider, and Bradley Settlemyer. 2022. GUFI: fast, secure file system metadata search for both privileged and unprivileged users. In Proceedings of the International Conference on High Performance Computing, Networking, Storage and Analysis (SC '22). IEEE Press, Article 57, 1–14. https://dl.acm.org/doi/abs/10.5555/3571885.3571960

Usage

See the root README for quick start instructions.

For more detailed instructions, see the user, administrator, and developer guides that will be placed into docs/latex/pdfs if building them is enabled with the CMake configuration -DLATEX_BUILD=On.

GUFI-SQL.docx provides guidance on GUFI's SQL schema, functions, and usage.

Directory Structure

  • config - Example GUFI wrapper script configuration files
  • contrib - Contains support files (cmake package finders, CI scripts, etc.)
  • docs - The documentation (you are here)
  • examples - Scripts showing how to run GUFI to perform various tasks
  • include - Headers
  • scripts - Scripts that will be installed
  • src - Source code for GUFI and executables
  • test - GUFI tests

Extra Information