Skip to content

Commit

Permalink
Added first 3 draft posts
Browse files Browse the repository at this point in the history
  • Loading branch information
mcoonen committed Aug 21, 2024
1 parent a531c5b commit 31b8342
Show file tree
Hide file tree
Showing 6 changed files with 191 additions and 0 deletions.
45 changes: 45 additions & 0 deletions _posts/2024-08-12-um-library-participates-in-nde-versnellen.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
layout: post
read_time: true
show_date: true
title: UM Library participates in NDE Versnellen 2023 (DRAFT)
description: NDE Versnellen 2023 call for proposals
date: 2024-08-12
img: posts/nde-versnellen.png
tags: [ omeka s, iiif, nde ]
author: Maryam Mazaheri, Maarten Coonen
---

### IIIF

The International Image Interoperability Framework (IIIF) is a set of open standards that is widely used by cultural
heritage institutions to facilitate sharing, displaying and annotation of high-resolution digital images.
It allows users to access, compare, and interact with images across various platforms seamlessly.
IIIF consists of a set of APIs that deliver functionality.

### Omeka S

Omeka S is a web publishing platform designed for institutions to manage and share digital collections and exhibits. It
supports linked data, enabling the creation of interconnected content across multiple sites, making it ideal for
collaborative projects and multi-institutional archives.

### NDE Versnellen

The Dutch Digital Heritage Network (NL: Netwerk Digitaal Erfgoed, NDE) is the main driving force for the
Dutch [national strategy for digital heritage](https://netwerkdigitaalerfgoed.nl/activiteiten/nationale-strategie-digitaal-erfgoed/).
In 2023 NDE launched a concept called "NDE compatibel werken" to make digital heritage content available and connected.
The concept consists of five key aspects:

1. Use of [persistent identifiers](https://netwerkdigitaalerfgoed.nl/activiteiten/duurzame-identifiers-bij-de-bron/)
2. Link to URIs of standardized terms via the NDE [Network of Terms](https://termennetwerk.netwerkdigitaalerfgoed.nl/)
3. Publish heritage information as [linked (open) data](https://netwerkdigitaalerfgoed.nl/activiteiten/linked-data-2/)
4. Make datasets discoverable by others via the [Dataset Registry](https://datasetregister.netwerkdigitaalerfgoed.nl/)
5. Use [IIIF](https://netwerk-digitaal-erfgoed.github.io/requirements-collection-management-systems/) for access to
image collections.

The Dutch Digital Heritage Network is supporting heritage organisations to move to NDE compatible systems with their
subsidy program called [NDE Versnellen](Dutch Digital Heritage Network). Maastricht University Library participated in
this call for proposals in 2023 with a project to implement IIIF functionalities on top of their Omeka S instance and
becoming fully NDE-compliant.

This series of blog posts will present our results and lessons learned.
129 changes: 129 additions & 0 deletions _posts/2024-08-13-getting-started-with-iiif-omekas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
---
layout: post
read_time: true
show_date: true
title: Getting started with IIIF and Omeka S (DRAFT)
description: How to get Omeka S and IIIF running with Docker
date: 2024-08-13
img: posts/docker-omekas-iiif.jpg
tags: [ omeka s, iiif, docker ]
author: Maarten Coonen
---

In our [previous post](./um-library-participates-in-nde-versnellen.html) we described the "NDE Versnellen 2023"
project in which we planned to make our Omeka S instance fully NDE compatible by implementing the IIIF-functionality on
top of it.

This post presents the results of that project by guiding you through an easy-to-setup Dockerized environment consisting
of Omeka S with IIIF preconfigured. We made this Dockerized Omeka S environment freely available under a GPL-3.0 open
source license.

**Please note that this Dockerized environment was designed for development purposes. We would not recommend production
usage in its current state! Read our [next post](./installing-iiif-with-omekas.html) with deployment instructions instead.**

### Before you start

In order to run our Dockerized Omeka S, you need a system with the following characteristics and software installed.

- A supported operating system, such as various Linux distros or MacOS. Details
on [Docker website](https://docs.docker.com/engine/install/)
- Docker & Docker Compose
- Git

### Create a working directory

```bash
cd ~
mkdir work
cd ~/work
```

### Clone our git repositories

Load our software from the Maastricht University Library GitHub. The steps below are based on
this [readme](https://github.com/MaastrichtU-Library/omekas-docker/blob/master/README.md) and repeated here for
convenience.

In order to resolve DNS requests to the local containers, you need to add the following line to your local `/etc/hosts` file.
```bash
127.0.0.1 localhost omeka.local solr.local db.local iipsrv.local cantaloupe.local viewer.local
```

Download the Omeka S Docker project:
```bash
git clone https://github.com/MaastrichtU-Library/omekas-docker.git
```

Download the Omeka S theme and helper scripts
```bash
cd ~/work/omekas-docker/externals
git clone https://github.com/MaastrichtU-Library/omekas-helpers.git
git clone https://github.com/MaastrichtU-Library/omekas-theme-um.git
```


Set database connection settings

1. Edit the `~/work/omekas-docker/docker-compose.yml` file and enter values for:
```bash
MYSQL_ROOT_PASSWORD:
MYSQL_DATABASE:
MYSQL_USER:
MYSQL_PASSWORD:
```

1. Copy the example database config for Omeka S
```bash
cp ~/work/omekas-docker/omeka-s/config/example_database.ini ~/work/omekas-docker/omeka-s/config/database.ini
```

1. Edit the `database.ini` file with a text editor and enter the same values for:
```bash
user =
password =
dbname =
host =
```

### Run Omeka S in Docker
Build the Omeka S infra with:
```bash
docker compose build
```

Additionally, to build the external IIIF-tooling, use:
```bash
docker compose -f docker-compose-iiif-external.yml build
```

Run the Omeka S infra with:
```bash
docker compose up -d
```

To run external IIIF-tooling as well, use:
```bash
docker compose -f docker-compose-iiif-external.yml up -d
```

To see logs, use:
```bash
docker compose logs -f
```

There are some manual configuration steps to perform after the Docker containers have started.
- [Configure Solr backend](README-02-Solr.md)

When all containers have started, you will find the services at the following URLs:
- **Omeka S:** http://omeka.local _(usr/pwd: [email protected] / foobar)_
- **mySQL backend:** http://db.local
- **Solr backend:** http://solr.local
- **IIP IIIF server:** http://iipsrv.local
- **Cantaloupe IIIF server:** http://cantaloupe.local _(usr/pwd: admin / foobar)_
- **Mirador external IIIF viewer:** http://viewer.local



### Well done
If everything worked out, you now have a working Omeka S with IIIF features running locally.
Stay tuned for our [next post](./installing-iiif-with-omekas.html) with instructions for production usage.
17 changes: 17 additions & 0 deletions _posts/2024-08-14-installing-iiif-with-omekas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
layout: post
read_time: true
show_date: true
title: Installing IIIF to Omeka S (DRAFT)
description: How to get Omeka S and IIIF running in production
date: 2024-08-14
img: posts/installing-omekas-iiif.jpg
tags: [ omeka s, iiif, docker ]
author: Maarten Coonen
---

In our [previous post](./getting-started-with-iiif-omekas.html) we talked about a quick way to get IIIF and Omeka S
running locally with Docker. In this post we describe the steps to take when installing IIIF to your Omeka S production
environment.


Binary file added assets/img/posts/docker-omekas-iiif.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/posts/installing-omekas-iiif.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/posts/nde-versnellen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 31b8342

Please sign in to comment.