Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
If you are on a Windows system (32-bit or 64-bit), the easiest way to install siegfried is to:
- download the latest install package from the releases page and
- copy the executable files into a location in your system's path.
E.g. create a
c:\utilsfolder and copy the executable files (sf.exe and roy.exe) there. Follow this guide to add
c:\utilsto your system's path.
You should now be able to run
sf from the command prompt.
Installing the latest signature file
In order to start identifying files, you will need to install a signature file.
sf has an update service to manage this. Type
sf -update at the command prompt and
sf will download the latest PRONOM signature file to a "siegfried" folder in your user directory (e.g.
You can also use the
sf -update command to download/update non-PRONOM signatures. Options are "loc", "tika", "freedesktop", "pronom-tika-loc", "deluxe" and "archivematica". To update a non-PRONOM signature, include the signature name as an argument after the flags e.g.
sf -update freedesktop. This command will overwrite 'default.sig' (the default signature file that sf loads). You can preserve your default signature file by providing an alternative
-sig target e.g.
sf -sig notdefault.sig -update loc. If you use one of the signature options as a filename (with or without a .sig extension), you can omit the signature argument i.e.
sf -update -sig loc.sig is equivalent to
sf -sig loc.sig -update loc.
Troubleshooting: If you are having trouble downloading the signature file (e.g. because of a corporate proxy or system security settings), you can manually install the latest signature by downloading this file, renaming it "default.sig", and copying it into a "siegfried" folder in your user directory. If you need to change your home directory, you can do so and can use any alternate directory, but will need to include
sf -home ALTERNATE_HOME_DIRfor every
sfcommand you run.
Congratulations, you are all set up and can start identifying files!
On OSX and Linux
The simplest way to install on OSX and Linux (ubuntu), is to use the brew or ubuntu packages.
brew install mistydemeo/digipres/siegfried
Or, for the most recent updates, you can install from this fork:
brew install richardlehane/digipres/siegfried
Ubuntu/Debian (64 bit):
wget -qO - https://bintray.com/user/downloadSubjectPublicKey?username=bintray | sudo apt-key add - echo "deb http://dl.bintray.com/siegfried/debian wheezy main" | sudo tee -a /etc/apt/sources.list sudo apt-get update && sudo apt-get install siegfried
pkg install siegfried
Installing from source
Downloading and building
roy is then simply:
go get github.com/richardlehane/siegfried/cmd/sf go get github.com/richardlehane/siegfried/cmd/roy
Copy your fresh binaries (they will be built in a "bin" folder within your $GOPATH folder) somewhere suitable that is in your system's path (e.g. create a $HOME/bin folder and add the line
PATH=$PATH:$HOME/bin to your $HOME/.profile file) and then install the latest signature file using
sf -update (full instructions same as for Windows users above).