DEPLOYING.md

Get It For Me Button Service Deployment Guide

Production Deployments

For production deployments, deploy using docker-compose via the GIFM Button App Repo. This is the recommended method of deployment for production systems. Go to the GIFM Button App Repo and following the deployment instructions there.

Performing the deployment using the GIFM Button App Repo should be something similar to the following:

docker-compose up

The development deployment can also use docker-compose in the same way.

(back to top)

Development Deployment using Docker

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

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

_{* Note: -t gifmservice and -it gifmservice 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 docker-compose via the GIFM Button App Repo or 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)