diff --git a/docs/_data/vars.yml b/docs/_data/vars.yml index ed11332..558618d 100644 --- a/docs/_data/vars.yml +++ b/docs/_data/vars.yml @@ -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" diff --git a/docs/assets/img/desktop.png b/docs/assets/img/viper-desktop.png similarity index 100% rename from docs/assets/img/desktop.png rename to docs/assets/img/viper-desktop.png diff --git a/docs/index.md b/docs/index.md index 0f7a8f3..6700d28 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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. +A screenshot depicting 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. diff --git a/docs/maintainer/index.md b/docs/maintainer/index.md index b91246c..62b58b0 100644 --- a/docs/maintainer/index.md +++ b/docs/maintainer/index.md @@ -2,6 +2,7 @@ layout: page title: Maintainer Guide --- +# Maintainer Guide This guide is intended for anybody interested in: @@ -14,7 +15,7 @@ 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 @@ -22,7 +23,7 @@ You'll need at least familiarity with the following software and technologies to ### 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 @@ -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 @@ -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: @@ -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 @@ -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/`; - 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 diff --git a/docs/setup/index.md b/docs/setup/index.md index 5368cd6..a655fdd 100644 --- a/docs/setup/index.md +++ b/docs/setup/index.md @@ -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