Deployment

This directory contains specific deployment instructions and examples for:

• Docker and Docker Compose
• Helm chart for Kubernetes
• Google Cloud Platform (GCP)
• Terraform infrastructure as code

Database

An external database is required for deployment, e.g. MySQL. Other database types supported by Spring Boot, such as PostgreSQL, may also work but have not been tested.

Authentication

Several identity providers are supported for authentication using OAuth 2.0, and need to be configured. For real-world hosting (not localhost), you will first need to register a custom domain name (your.domain in the examples below) and use HTTPS.

See specific deployment instructions to learn how to configure the clientID / clientSecret.

Google

• If you don't have a Google account, create it
• Then create a Google OAuth client
• Add Authorized redirect URIs: https://your.domain/login/oauth2/code/google
• Copy the OAuth client credentials (clientID / clientSecret)

GitHub

• If you don't have a GitHub account, create it
• Then register a new OAuth application
• Set Authorization callback URL: https://your.domain/login/oauth2/code/github
• Copy the OAuth client credentials (clientID / clientSecret)