This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Getting Started

Try Clawdite!

    This documentation is mainly targeted to Linux distributions (tests have been done on Ubuntu 22.04). However, Docker commands can be replicated on different OSs by installing the dedicated Docker library. Bash scripts are released for Linux-based OSs only.

    Prerequisites

    All the components are provided as Docker images, thus the following software is required:

    • Docker
    • Docker Compose

    We tested our deployment on a machine running Ubuntu 22.04, with Docker v27.3.1, and Docker Compose v1.29.2.

    Installation

    Download the Clawdite repository from GitLab by executing the following command:

    $ git clone git@gitlab-core.supsi.ch:dti-isteps/spslab/public/clawdite.git
    

    Setup

    Before running the containers, it is required to download the Docker images from their respective registries. While some images are publicly available, some other require credentials to be downloaded from private registries.

    Images provided by SUPSI can be download from the GitLab container registry, which supports the token-based authentication. Please send your request for a new token to the repository maintainers.

    Once you are provided with a username and a token, you can issue the following command to login to the private GitLab Docker registry and download the images:

    $ docker login registry.example.com -u <username> -p <token>
    $ docker-compose pull
    

    Try it out!

    Docker images are hosted in a private Docker Registry at gitlab-core.supsi.ch. Please contact the maintainers to get registry credentials.

    Run containers using Docker Compose:

    $ docker-compose up -d
    

    To stop the containers and delete all the managed volumes:

    $ docker-compose down -v