OCFL

Experimental OCFL client and library for interacting with OCFL content from an operational perspective.

Quickstart

Download or Build the ocfl cli application

You can create an OCFL root by using mkroot with a desired directory to create. Create one, and cd into it

ocfl mkroot ~/myRoot

cd ~/myRoot

Copy some content into an OCFL object. For example, recursively copy the contents of the /usr directory into an OCFL object named test:stuff

ocfl cp -r /usr test:stuff

List logical files and their physical paths in that object

ocfl ls -p -t file test:stuff

Copy some more stuff into the object (creating another version)

ocfl cp /etc/hosts test:stuff

Feel free to explore the files on the file system (e.g. the inventory) to see what it created, or explore the cli documentation for more things to do

Documentation

The OCFL client has built in help pages accessible by

ocfl help

.. or for a specific subcommand

ocfl help cp

For more in-depth examples see the cli documentation

Download

Pre-compiled binaries are present in the releases section. It's possible to download and extract the binaries to your PATH as follows:

For Mac OS:

$ base=https://github.com/birkland/ocfl/releases/download/v0.2.0 &&
  curl -L $base/ocfl-$(uname -s)-$(uname -m) >/usr/local/bin/ocfl &&
  chmod +x /usr/local/bin/ocfl

For Linux:

$ base=https://github.com/birkland/ocfl/releases/download/v0.2.0 &&
  curl -L $base/ocfl-$(uname -s)-$(uname -m) >/tmp/ocfl &&
  sudo install /tmp/ocfl /usr/local/bin/ocfl

For Windows, using Git Bash:

$ base=https://github.com/birkland/ocfl/releases/download/v0.2.0 &&
  mkdir -p "$HOME/bin" &&
  curl -L $base/ocfl-Windows-x86_64.exe > "$HOME/bin/ocfl.exe" &&
  chmod +x "$HOME/bin/ocfl.exe"

Build

Make sure you have Go 1.11+ installed

If you develop inside ${GOPATH} and/or have ${GOPATH}/bin in your path, you can simply do

go get github.com/birkland/ocfl/cmd/ocfl

Otherwise, clone the repository somewhere (not within ${GOPATH}), and cd into it

git clone https://github.com/birkland/ocfl.git

If ${GOPATH}/bin is in your PATH, then you can just do the following

go install ./...

Otherwise, to produce an ocfl executable in the build dir

go build ./...

Drivers

Planned drivers to explore

• file. OCFL in a regular filesystem
• index. OCFL metadata in a database for quick retrieval.
• s3. OCFL in Amazon S3

Http server

Not started yet. So if we have an index that allows fast lookup, an http server providing an API access to OCFL structure or content in a performant way. Experiments include:

• Dumb. Just read/write reflection of what's on the filesystem. Probably doesn't help us much.
• LDP. Use LDP containers strictly for listing stuff, which allows us to leverage that performant index and allows us to group things logically. e.g. http://example.org/ocfl/${object}/v3/path/to/file.txt
• Memento. Maybe a better way to expose versions, and expose current revisions as the "normal case"? e.g. from http://example.org/ocfl/${object}/path/to/file.txt memento explains there are three revisions of that file (say in v1, v2, and v4); from http://example.org/ocfl/${object} discover all revisions, etc.

Is there a natural way to expose OCFL as some subset of the Fedora API, or at least borrowing from it where it makes sense, or building on some of the specs it cites? Then we also expose checksums via Want-Digest, for example.