Skip to content

Cascade-Lab/cascade-docker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

image

Running Cascade with Docker

Download the Cascade Docker toolkit

Using git

git clone https://github.com/Cascade-Lab/cascade-docker.git
cd cascade-docker/

Or using wget

wget https://github.com/Cascade-Lab/cascade-docker/archive/refs/heads/master.zip
unzip master.zip
cd cascade-docker/

Install docker and docker compose if now yet installed

Courtesy scripts for Ubuntu and Debian are provided in the support folder. Please refer to the official Docker documentation for installation instructions for your platform. https://docs.docker.com/engine/install/

chmod +x support/docker-install-ubuntu.sh
./support/docker-install-ubuntu.sh

Log into the Cascade Container Registry

docker login -u User -p Docker-Password cascadelab.azurecr.io

Note: Docker-User and Docker-Password are provided by Cascade client care.

https://docs.docker.com/engine/reference/commandline/login/#credentials-store

Customize Password

Open the 'db_password.txt' file and update the password to your desired one

Creating Database and Attachment Folders

Step 1: Create Necessary Folders for the data at your desired location .

Go to the desired location and execute the following command in your terminal:

mkdir -p data/db data/documents

After running this command:

The data/db and data/documents directories will be created within your desired location.

Step 2: Update Docker Compose Configuration

In your “docker-compose.yaml” file, update the volume paths with the path where you created data/db and data/documents directories:

volumes:
  db-data:
    driver_opts:
      type: none
      o: bind
      device: /<pathToDataDirectory>/data/db
  app-data:
    driver_opts:
      type: none
      o: bind
      device: /<pathToDataDirectory>/data/documents

Start Cascade

Make sure you are in the cascade-docker folder.

docker compose up

Wait 1-2 minutes then go to http://localhost:8080/ , this screen should appear:

image

Then, enter and activate the license.

Note: License is provided by Cascade client care.

Once License has been activated, a login screen like this should display:

image

You will have to connect with the following credentials:

Username: [email protected]

Password: secret

Opening external access

The application can be connected to two domains and their subdomains, which should be available from your infrastructure in case of usage:

  • neterium.cloud (Name screening API - Neterium)
  • sentry.io (Error tracking - Sentry. Optional)

To be sure that the application can connect, go to Health Dashboard:

image

And check if the Screening API field is working:

image

Secure Password

Make sure you are in the cascade-docker folder.

chmod 600 db_password.txt

After running this command, the file will have permissions set to 600, granting read and write access only to the file owner while denying access to other users.

Stop Cascade

It is possible to stop Cascade, first make sure you are in the cascade-docker folder, then execute the following command line.

docker compose stop

Backup Cascade

The data folder is what you need to backup.

Update Cascade

To update Cascade using Docker, you'll need to utilize the latest image released by Cascade. For example:

cascadelab.azurecr.io/cascade-lab/cascade/prod:v5.7.0

The latest Docker image is provided by Cascade Client Care. Once you have the Docker image, replace the old image with the new one provided in the docker-compose.yaml file.

app: 

    restart: always 

    image: cascadelab.azurecr.io/cascade-lab/cascade/prod:v4.3.0 

    depends_on: 

Navigate to the folder containing your docker-compose.yaml file, then run the following commands:

docker-compose pull
docker-compose up -d

The first command (docker-compose pull) updates the images, and the second (docker-compose up - d) recreates and restarts the containers in detached mode with the latest images.

Congratulations! You've successfully completed the Docker setup for Cascade. Should you have any further questions or encounter any issues, don't hesitate to reach out to our support team.

About

Cascade Docker Toolkit

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages