fs

Overview ¶

Package fs implements filesystem-based storage for Omnom snapshots and resources.

This package provides the Storage type which implements the storage.Storage interface using the local filesystem. All content is stored in a configurable base directory with the following structure:

<base_dir>/
  snapshots/
    <2-char-prefix>/
      <hash>.html.gz
  resources/
    <2-char-prefix>/
      <hash><extension>

All files are compressed with gzip before being written to disk. The two-character prefix directories (based on the first two characters of the content hash) help distribute files across multiple directories to avoid filesystem performance issues.

Example usage:

storage, err := fs.New(config.StorageFilesystem{
    RootDir: "./data",
})
if err != nil {
    log.Fatal(err)
}

// Storage implements the storage.Storage interface
err = storage.SaveSnapshot(key, content)