DEPLOYING.md

Institutional Repository International Image Interoperability Framework Service Deployment Guide

Production Deployments

For production deployments, deployment should ideally be done using docker-compose. However, there is currently no App repository for IRIIIF Service providing a docker-compose file.

For now, production deployments are identical to development deployments as described in the Docker method below.

(back to top)

Development Deployment using Docker

To manually use docker rather than docker-compose, run the following:

docker image build -t iriifservice .
docker run -it iriifservice

_{* Note: -t iriifservice and -it iriifservice may be changed to another tag name as desired, such as -t developing_on_this and -it developing_on_this.}

(back to top)

Development Deployment using Maven

Manual deployment can be summed up by running:

mvn spring-boot:run

Those steps are a great way to start but they also fail to explain the customization that is often needed. There are multiple ways to further configure this for deployment to better meet the desired requirements.

It is highly recommended only to perform manual installation when developing. For production deployment, please use the Docker method above.

(back to top)

Directly Configuring the src/main/resources/application.yml File

This method of configuration works by altering the configuration file.

With this in mind, the deployment steps now look like:

# Edit 'src/main/resources/application.yml' here.

mvn spring-boot:run

(back to top)