Configuration#

The configuration for the Software Heritage Filesystem resides in the swh > fuse section of the shared YAML configuration file used by all Software Heritage tools, located by default at ~/.config/swh/global.yml.

The configuration file location is subject to the XDG Base Directory specification as well as explicitly overridden on the command line via the -C/--config-file flag.

You can choose how swh-fuse will fetch content from the archive. The simplest (and default) way is to query the SWH public API. This method can be configured with the following block:

  • web-api:

    • url: archive API URL

    • auth-token: (optional) authentication token used with the API URL

You can use a compressed graph close to your server, via its gRPC API, to traverse the folder hierarchy much faster. This can be configured with the following block:

swh-fuse will also search for the following options:

  • cache:

    • metadata: where to store the metadata cache, must have either a in-memory boolean entry set to true or a path string entry (with the corresponding disk path).

    • blob: where to store the blob cache, same entries as the metadata cache.

    • direntry: how much memory should be used by the direntry cache, specified using a maxram entry (either as a percentage of available RAM, or with disk storage unit suffixes: B, KB, MB, GB).

  • json-indent: number of spaces used to print JSON metadata files (setting it to null disables indentation).

If no configuration is given, default values are:

  • cache: all cache files are stored in $XDG_CACHE_HOME/swh/fuse/ (or ~/.cache/swh/fuse if XDG_CACHE_HOME is not set). The direntry cache will use at most 10% of available RAM.

  • web-api: URL is https://archive.softwareheritage.org/api/1/, with no authentication token

  • json-indent: 2 spaces.

Examples#

Here is a full ~/.config/swh/global.yml equivalent to the default configuration:

swh:
  fuse:
    cache:
      metadata:
        path: "/path/to/cache/blob.sqlite"
      blob:
        path: "/path/to/cache/blob.sqlite"
      direntry:
        maxram: 10%
    web-api:
      url: "https://archive.softwareheritage.org/api/1/"
    json-indent: 2

This example uses a local compressed graph, an in-memory cache for metadata, and authenticates against the SWH public API to benefit from higher rate limits:

swh:
  fuse:
    cache:
      metadata:
        in-memory: true
      blob:
        path: "/path/to/cache/blob.sqlite"
    graph:
      grpc-url: localhost:50091
    web-api:
      url: "https://archive.softwareheritage.org/api/1/"
      auth-token: eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJhMTMxYTQ1My1hM2IyLTQwMTUtO...

Logging#

The default logging level is set to INFO and can be configured through the shared command line interface via the -l/--log-level flag.

$ swh --log-level swh.fuse:DEBUG fs mount swhfs/
On this page
Edit

This Page