Deploying

Deploy a pre-packaged build.

Prerequisites

• Docker, with Docker Compose
  • https://docs.docker.com/engine/install/

---

Last Tested on RHEL 9.4, with Docker version 27.0.2 and Docker Compose version v2.28.1.

1. Clone the Git repository, or grab the latest release source code.
   • git clone https://github.com/wqyeo/Cappu-Crypt.git
2. Duplicate .env.example into .env.
   • Modify .env as needed.
3. Grab the .jar file from the latest releases.
4. Move the .jar file into a new folder target in the project's directory.
5. Run Docker Compose on the provided file.
   • docker-compose up --build
6. Your API endpoint is now accessible.
   • External Facing API Port is based on .env.
   • Docker network port defaults to 8080.

The docker compose comes with a PostgreSQL container.
If you are using your own database instance elsewhere, you can modify docker-compose.yml to remove the PostgreSQL service.

Build and Deploy

Prerequisites

• Docker, with Docker Compose
  • https://docs.docker.com/engine/install/
• Maven
  • https://maven.apache.org/download.cgi

---

Last tested on Debian 12, with Apache Maven 3.8.7, Docker version 20.10.25 and
docker-compose version 1.29.2.

1. Clone the Git repository, or grab the latest release source code.
   • git clone https://github.com/wqyeo/Cappu-Crypt.git
2. Duplicate .env.example into .env.
   • Modify .env as needed.
3. Package the project with Maven.
   • mvn package -DskipTests=true -f pom.xml
4. Run Docker Compose on the provided file.
   • docker-compose up --build
5. Your API endpoint is now accessible.
   • External Facing API Port is based on .env.
   • Docker network port defaults to 8080.

The docker compose comes with a PostgreSQL container.
If you are using your own database instance elsewhere, you can modify docker-compose.yml to remove the PostgreSQL service.