Skip to content

Commit

Permalink
DOC: ViPER v1.2 updates
Browse files Browse the repository at this point in the history
- updated ViPER version -> v1.2;
- updated JHOVE version -> 1.30.1; and
- added desktop screen shot and tweaked wording.
  • Loading branch information
carlwilson committed Aug 2, 2024
1 parent 08aca61 commit 2db4ba2
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 9 deletions.
6 changes: 3 additions & 3 deletions docs/_data/vars.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
version: "1.2-rc1"
release_date: "20.06.2024"
version: "1.2"
release_date: "01.08.2024"
guest_os: "Debian"
guest_os_version: "12"
guest_os_nickname: "Bookworm"
droid_version: "6.7.0"
jhove_version: "1.30.0"
jhove_version: "1.30.1"
verapdf_version: "1.26.2"
tika_version: "2.9.2"
handbrake_version: "1.6.1"
Expand Down
File renamed without changes
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ banner: "/assets/img/viper-header.png"

Developed in collaboration with the Dutch Digital Heritage Network, ViPER is an easy-to-install virtual machine running popular open source preservation tools with graphical user interfaces: DROID, HandBrake, JHOVE, MediaConch, Mediainfo, Tika and veraPDF. With this virtual machine, we aim to reduce barriers to using and testing digital preservation software.

<img src="/assets/img/viper-desktop.png" class="img-fluid" alt="A screenshot depicting the ViPER desktop." title="The ViPER desktop.">

With a selection of open source digital preservation tools pre-installed, it enables users to try out tools typically used in the pre-ingest and ingest stages of a digital preservation workflow, without having to install or configure the software. You can research them before making decisions about which to use in your production environment.

ViPER is now maintained by the Open Preservation Foundation.
15 changes: 10 additions & 5 deletions docs/maintainer/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
layout: page
title: Maintainer Guide
---
# Maintainer Guide

This guide is intended for anybody interested in:

Expand All @@ -14,15 +15,15 @@ It's not intended as a primer on the underpinning technologies, we assume that r
are technically proficient. If you just want to use ViPER and you're looking for help
the please refer to the [setup guide](../setup/) or [user's guide](../guide/).

ViPER is an easy-to-install virtual machine running popular open source preservation tools with graphical user interfaces. It was created by the [Open Preservation Foundation(https://openpreservation.org/)] (OPF) and funded by the [Dutch Digital Heritage Network](https://www.netwerkdigitaalerfgoed.nl/) (DDHN). ViPER is maintained by the OPF and the [National Archives of the Netherlands](https://www.nationaalarchief.nl/).
ViPER is an easy-to-install virtual machine running popular open source preservation tools with graphical user interfaces. It was created by the [Open Preservation Foundation(https://openpreservation.org/)] (OPF) and funded by the [Dutch Digital Heritage Network](https://www.netwerkdigitaalerfgoed.nl/) (DDHN). ViPER is now maintained by the OPF and the [National Archives of the Netherlands](https://www.nationaalarchief.nl/).

## Technologies

You'll need at least familiarity with the following software and technologies to follow the guide.

### Operating system

[Debian 12 (Bookworm)](https://www.debian.org/) was chosen as a base OS. The two main criteria that guided the decision were stability and long update cycles.
[{{ site.data.vars.guest_os }} {{ site.data.vars.guest_os_version }} ({{ site.data.vars.guest_os_nickname }})](https://www.debian.org/) is the base OS. The two main criteria that guided the decision were stability and long update cycles.

### Virtualisation

Expand All @@ -48,7 +49,7 @@ The VirtualBox VM is initialised with on the following line, which also selects
config.vm.box = "debian/bookworm64"
```

This choses a 64 bit Debian 12 (Bookworm) image as the base OS.
This choses a 64 bit {{ site.data.vars.guest_os }} {{ site.data.vars.guest_os_version }} ({{ site.data.vars.guest_os_nickname }}) image as the base OS.

#### VirtualBox configuration

Expand All @@ -59,7 +60,7 @@ We can set these up for a VirtualBox VM by adding the following lines to our Vag
```ruby
config.vm.provider "virtualbox" do |vb|
# Name the prototype machine
vb.name = "VIPER v1.1"
vb.name = "VIPER v1.2"
# Display the VirtualBox GUI when booting the machine
vb.gui = true
# Customize the CPUs (2x) and memory (4GB) on the VM:
Expand Down Expand Up @@ -111,7 +112,7 @@ end

### Ansible Playbook

The playbook [`ansible/initialise-env.yaml`](https://github.com/openpreserve/ViPER/blob/main/ansible/initialise-env.yml) is the list of roles that set up the virtual research environment.
The playbook [`ansible/initialise-env.yaml`](https://github.com/openpreserve/ViPER/blob/main/ansible/initialise-env.yml) is the list of roles that set up the ViPER environment.
An Ansible role is simply a set of tasks that achieve a desired state, e.g. install software, copy files, etc..

### Ansible Roles
Expand Down Expand Up @@ -152,3 +153,7 @@ The [`viper.tools`](https://github.com/openpreserve/ViPER/blob/main/ansible/role
- download the tool installation package and install to `/usr/local/lib/<tool-name>`;
- add any required symlinks to `/usr/local/bin` so that tool executables are effectively on the path; and
- put an icon for the tool GUI on the desktop.

## Updating the environment

## Updating the tools
2 changes: 1 addition & 1 deletion docs/setup/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This guide is intended to help you install VirtualBox then download and import t

## About ViPER

ViPER is an easy-to-install virtual machine running popular open source preservation tools with graphical user interfaces. It was created by the [Open Preservation Foundation](https://openpreservation.org/) (OPF) and funded by the [Dutch Digital Heritage Network](https://www.netwerkdigitaalerfgoed.nl/en/) (DDHN). ViPER is maintained by the [National Archives of the Netherlands](https://www.nationaalarchief.nl/) and the OPF. [Oracle VirtualBox](https://www.virtualbox.org/manual) that provides the basis for cross platform virtualisation and makes use of [Gnome](https://www.gnome.org/gnome-3/) that provides the default desktop environment.
ViPER is an easy-to-install virtual machine running popular open source preservation tools with graphical user interfaces. It was created by the [Open Preservation Foundation](https://openpreservation.org/) (OPF) and funded by the [Dutch Digital Heritage Network](https://www.netwerkdigitaalerfgoed.nl/en/) (DDHN). ViPER is now maintained by the OPF and the [National Archives of the Netherlands](https://www.nationaalarchief.nl/). [Oracle VirtualBox](https://www.virtualbox.org/manual) that provides the basis for cross platform virtualisation and makes use of [Gnome](https://www.gnome.org/gnome-3/) that provides the default desktop environment.

## Pre reqs

Expand Down

0 comments on commit 2db4ba2

Please sign in to comment.