acearchive / ipfs-bib

[UNMAINTAINED] A tool for hosting bibliographic references on IPFS

⚠ UNMAINTAINED

Since it is no longer being used for Ace Archive, I am not planning on maintaining this tool.

ipfs-bib

ipfs-bib is a tool for hosting bibliographic references on IPFS. The tool pulls citations from a bibtex/biblatex file or a public Zotero library, finds the full text of the research on the legacy web, and rehosts it on a local IPFS node or exports it to a CAR archive.

Features

• Pull citations from a bibtex/biblatex file or a public Zotero library.
• Host content on a local IPFS node or export it to a CAR archive. You can pin content on your local node or add it to MFS.
• Pin content with IPFS pinning services that support the pinning service API.
• Generate a new biblatex file containing the new URLs of the content on IPFS. Both ipfs:// and gateway URLs are supported.
• Pulls open-access full-text articles from Unpaywall.
• Configure custom link resolvers for accessing full-text articles through your educational institution or any service that removes barriers in the way of science.
• Can access local full-text articles downloaded by Zotero.
• Can take snapshots of web pages using monolith when a PDF isn't available. This requires monolith to be installed separately.
• Pulls embedded documents from sites that don't serve PDFs directly.
• Can produce JSON output for hacking and scripting. The format of the JSON output is documented here.

Configuration

The behavior of the program can be configured via a config file. See the default config file for documentation and examples.

The tool will produce a single UnixFS directory in IPFS with a subdirectory for each source, and each of those subdirectories will contain the full-text article. Both the name of the directory and the name of the file can be configured in the config file.

Some fields in the config file accept a Golang text/template template. In these templates, functions provided by the Sprig library are available.

Usage

To use the CLI, you must first install Go.

To run the CLI and see the help:

go run . --help

A tool for hosting bibliographic references on IPFS.

This command accepts the path of a bibtex/biblatex file, or `-` to read from stdin.
If --zotero is passed, this accepts a Zotero group ID instead.

Usage:
  ipfs-bib [options] <bibtex_file>

Flags:
      --car path          Rather than add the sources to an IPFS node, export them as a CAR archive at this path.
  -c, --config path       The path of the config file to use. Otherwise, use the default config.
      --dry-run           Download sources, but don't add them to IPFS or export them as a CAR.
  -h, --help              help for ipfs-bib
      --json              Produce machine-readable JSON output.
      --mfs path          Add the sources to MFS at this path.
  -o, --output path       Generate a new bibtex file at this path with the IPFS URLs added to each entry.
      --pin               Pin the source files when adding them to the IPFS node.
      --pin-remote name   Pin the source files using each of the configured IPFS pinning services. Pass a name for the pin.
  -v, --verbose           Print verbose output.
      --version           version for ipfs-bib
      --zotero            Pull references from a public Zotero library. Pass a Zotero group ID.