-
Notifications
You must be signed in to change notification settings - Fork 30
Getting started
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.exeandroy.exe) there. Follow this guide to addc:\utilsto your system's path.
You should now be able to run sf from the command prompt.
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. c:\Users\richardlehane\AppData\Local\siegfried)
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 uses. 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 everysfcommand you run.
Congratulations, you are all set up and can start identifying files!
The simplest way to install on OSX and Linux (ubuntu), is to use the brew or ubuntu packages.
Mac Homebrew (or Linuxbrew):
brew install richardlehane/digipres/siegfried
The original recipe was contributed by @mistydemeo.
curl -sL "http://keyserver.ubuntu.com/pks/lookup?op=get&search=0x20F802FE798E6857" | gpg --dearmor | sudo tee /usr/share/keyrings/siegfried-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/siegfried-archive-keyring.gpg] https://www.itforarchivists.com/ buster main" | sudo tee -a /etc/apt/sources.list.d/siegfried.list
sudo apt-get update && sudo apt-get install siegfried
pkg install siegfried
To install from source, first download and install golang. For help setting Go up, read the Getting Started guide.
Make sure that $GOPATH is correctly setup and $GOPATH/bin is visible on your $PATH. The commands below will use Go to build and install sf and roy in $GOPATH/bin.
Downloading and building sf and roy is done with:
go install github.com/richardlehane/siegfried/cmd/sf@latest
go install github.com/richardlehane/siegfried/cmd/roy@latest
If you prefer not to setup $GOPATH/bin then copy your fresh binaries from there to 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).
Install the latest signature file using sf -update to download the latest signature from the https://www.itforarchivists.com/ update service (the complete download options are the same as for Windows users above).