|
| 1 | +--- |
| 2 | +layout: post |
| 3 | +read_time: true |
| 4 | +show_date: true |
| 5 | +title: Getting started with IIIF and Omeka S (DRAFT) |
| 6 | +description: How to get Omeka S and IIIF running with Docker |
| 7 | +date: 2024-08-13 |
| 8 | +img: posts/docker-omekas-iiif.jpg |
| 9 | +tags: [ omeka s, iiif, docker ] |
| 10 | +author: Maarten Coonen |
| 11 | +--- |
| 12 | + |
| 13 | +In our [previous post](./um-library-participates-in-nde-versnellen.html) we described the "NDE Versnellen 2023" |
| 14 | +project in which we planned to make our Omeka S instance fully NDE compatible by implementing the IIIF-functionality on |
| 15 | +top of it. |
| 16 | + |
| 17 | +This post presents the results of that project by guiding you through an easy-to-setup Dockerized environment consisting |
| 18 | +of Omeka S with IIIF preconfigured. We made this Dockerized Omeka S environment freely available under a GPL-3.0 open |
| 19 | +source license. |
| 20 | + |
| 21 | +**Please note that this Dockerized environment was designed for development purposes. We would not recommend production |
| 22 | +usage in its current state! Read our [next post](./installing-iiif-with-omekas.html) with deployment instructions instead.** |
| 23 | + |
| 24 | +### Before you start |
| 25 | + |
| 26 | +In order to run our Dockerized Omeka S, you need a system with the following characteristics and software installed. |
| 27 | + |
| 28 | +- A supported operating system, such as various Linux distros or MacOS. Details |
| 29 | + on [Docker website](https://docs.docker.com/engine/install/) |
| 30 | +- Docker & Docker Compose |
| 31 | +- Git |
| 32 | + |
| 33 | +### Create a working directory |
| 34 | + |
| 35 | +```bash |
| 36 | +cd ~ |
| 37 | +mkdir work |
| 38 | +cd ~/work |
| 39 | +``` |
| 40 | + |
| 41 | +### Clone our git repositories |
| 42 | + |
| 43 | +Load our software from the Maastricht University Library GitHub. The steps below are based on |
| 44 | +this [readme](https://github.com/MaastrichtU-Library/omekas-docker/blob/master/README.md) and repeated here for |
| 45 | +convenience. |
| 46 | + |
| 47 | +In order to resolve DNS requests to the local containers, you need to add the following line to your local `/etc/hosts` file. |
| 48 | +```bash |
| 49 | +127.0.0.1 localhost omeka.local solr.local db.local iipsrv.local cantaloupe.local viewer.local |
| 50 | +``` |
| 51 | + |
| 52 | +Download the Omeka S Docker project: |
| 53 | +```bash |
| 54 | +git clone https://github.com/MaastrichtU-Library/omekas-docker.git |
| 55 | +``` |
| 56 | + |
| 57 | +Download the Omeka S theme and helper scripts |
| 58 | +```bash |
| 59 | +cd ~/work/omekas-docker/externals |
| 60 | +git clone https://github.com/MaastrichtU-Library/omekas-helpers.git |
| 61 | +git clone https://github.com/MaastrichtU-Library/omekas-theme-um.git |
| 62 | +``` |
| 63 | + |
| 64 | + |
| 65 | +Set database connection settings |
| 66 | + |
| 67 | +1. Edit the `~/work/omekas-docker/docker-compose.yml` file and enter values for: |
| 68 | + ```bash |
| 69 | + MYSQL_ROOT_PASSWORD: |
| 70 | + MYSQL_DATABASE: |
| 71 | + MYSQL_USER: |
| 72 | + MYSQL_PASSWORD: |
| 73 | + ``` |
| 74 | + |
| 75 | +1. Copy the example database config for Omeka S |
| 76 | + ```bash |
| 77 | + cp ~/work/omekas-docker/omeka-s/config/example_database.ini ~/work/omekas-docker/omeka-s/config/database.ini |
| 78 | + ``` |
| 79 | + |
| 80 | +1. Edit the `database.ini` file with a text editor and enter the same values for: |
| 81 | + ```bash |
| 82 | + user = |
| 83 | + password = |
| 84 | + dbname = |
| 85 | + host = |
| 86 | + ``` |
| 87 | + |
| 88 | +### Run Omeka S in Docker |
| 89 | +Build the Omeka S infra with: |
| 90 | +```bash |
| 91 | +docker compose build |
| 92 | +``` |
| 93 | + |
| 94 | +Additionally, to build the external IIIF-tooling, use: |
| 95 | +```bash |
| 96 | +docker compose -f docker-compose-iiif-external.yml build |
| 97 | +``` |
| 98 | + |
| 99 | +Run the Omeka S infra with: |
| 100 | +```bash |
| 101 | +docker compose up -d |
| 102 | +``` |
| 103 | + |
| 104 | +To run external IIIF-tooling as well, use: |
| 105 | +```bash |
| 106 | +docker compose -f docker-compose-iiif-external.yml up -d |
| 107 | +``` |
| 108 | + |
| 109 | +To see logs, use: |
| 110 | +```bash |
| 111 | +docker compose logs -f |
| 112 | +``` |
| 113 | + |
| 114 | +There are some manual configuration steps to perform after the Docker containers have started. |
| 115 | +- [Configure Solr backend](README-02-Solr.md) |
| 116 | + |
| 117 | +When all containers have started, you will find the services at the following URLs: |
| 118 | +- **Omeka S:** http://omeka.local _(usr/pwd: admin@example.org / foobar)_ |
| 119 | +- **mySQL backend:** http://db.local |
| 120 | +- **Solr backend:** http://solr.local |
| 121 | +- **IIP IIIF server:** http://iipsrv.local |
| 122 | +- **Cantaloupe IIIF server:** http://cantaloupe.local _(usr/pwd: admin / foobar)_ |
| 123 | +- **Mirador external IIIF viewer:** http://viewer.local |
| 124 | + |
| 125 | + |
| 126 | + |
| 127 | +### Well done |
| 128 | +If everything worked out, you now have a working Omeka S with IIIF features running locally. |
| 129 | +Stay tuned for our [next post](./installing-iiif-with-omekas.html) with instructions for production usage. |
0 commit comments