Skip to content

Deploying

Yeo Wen Qin, Kaynn edited this page Jun 28, 2024 · 7 revisions

Prerequisites

Build and Deploy

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.

Clone this wiki locally