Cloudant Backup Service

This service is designed to back up one or multiple Cloudant databases to a file and uploaded to a Cloud Object Storage (COS) bucket on IBM Cloud.

Prerequisites

• PNPM
• Node v18
• Docker
• Docker Compose

Configuration

The service is configured using environment variables.

Please refer to the .env.example file for the list of environment variables that need to be set.

Installing dependencies

To install the dependencies, you can use the following command:

pnpm install

Running the service

⚠️ Please note that you need to set the required environment variables before running the service.

To run the service, you can use the following command:

pnpm start

Running the service in development mode

To run the service in development mode, you can use the following command:

pnpm start:dev

Running the service using Docker

To run the service using Docker, you can use the following command:

./containerizer dev build && ./containerizer dev up

Optionally, you can use the following command to run the service using Docker in production mode:

./containerizer prod build && ./containerizer prod up