Omeka S Installation with Docker Tutorial

How to run an Omeka-S Docker image on Linux-based distro’s.

For this guide we will be using the following repository from the Ghent University: https://github.com/GhentCDH/Omeka-S-Docker.git

In your system, open a terminal. Navigate to the location where you would like to place the docker-file. example:
```
cd Desktop/applications
```
clone the git repository
```
git clone https://github.com/GhentCDH/Omeka-S-Docker.git
```
This command will create a new folder named Omeka-S-Docker inside the Applications directory and copy all files from the repository into this folder.
To verify that the repository has been cloned successfully, list the contents of the Applications directory:
```
ls
```
You should see a directory named Omeka-S-Docker in the output. Now you can navigate to this folder:
```
cd Omeka-S-Docker
```
Now we will closely follow the instruction from the repo with some extra clarification steps and notes.

Before any further step, the configuration files first need to be set up. This is because Omeka-S uses the MySQL login credentials to connect to the database. In the Omeka-S-Docker folder there is an example.env file, which is an example of how to set it up.

The first step forward is to make a copy of the example.env file to .env (this will be how the new file is called) and update the values as needed:

# MySQL/MariaDB configuration
MYSQL_ROOT_PASSWORD=your_root_password
MYSQL_DATABASE=omeka_db
MYSQL_USER=omeka_usr
MYSQL_PASSWORD=your_password
MYSQL_HOST=omeka-db

# Omeka-S SMTP configuration
# For more details, see: https://docs.laminas.dev/laminas-mail/transport/smtp-options/
EMAIL_HOST=smtp.example.com
EMAIL_PORT=587
EMAIL_USER=your_email_user
EMAIL_PASSWORD=your_email_password
EMAIL_CONNECTION_TYPE=tls
HOST_NAME=example.com

The variables were set up during the installation process of MySQL, see Prerequisites Installation Guide for Linux, step 2-7.

To update the files, you can do this by opening the .env file in a text editor or with the terminal.

following step 6 where you ended up in the Omeka-S-Docker folder; make a copy of example.env and name it .env
```
cp example.env .env
```
edit .env file
```
nano .env
```
move arrows up-down to backspace the example credentials and add your own.
save changes with ctrl-o and enter then leave file ctrl-x

now that the .env file is set up accordingly to your credentials, we can move forward with building the docker file.

You should be (or navigate to) the Omeka-S-Docker folder. Then you can follow with:

docker compose up

When encountering an error; check that root permission is given by trying the following instead:

sudo docker compose up

If you still encounter issues such as:

docker: 'compose' is not a docker command.

Then it might be because of your distro. Check the documentation at (https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) Once started, you can access the Omeka-S installation at http://localhost:8080 and PHPMyAdmin at http://localhost:8081.

You should get a build of 3/3 components omeka-s-docker-omeka-db-1, omeka-s-docker-omeka-db-admin-1 and omeka-s-docker-omeka-web-1 If something goes wrong during this phase then it is likely a credential issue. please stop the process and check that the prerequisites are set up properly. Happy coding!