miniChRIS-podman

Requirements

podman version 4.4.1 and up

Abstract

miniChRIS-podman is a fork of miniChRIS-docker which uses Podman instead of Docker. See miniChRIS-docker/README.md for more info.

Image tags are pinned to stable versions, so miniChRIS might be out-of-date with development versions of ChRIS components.

miniChRIS-podman is not suitable as a development environment for the ChRIS services themselves, please see their respective respositories for information on how to run them in development mode.

miniChRIS-podman Project Goals

Support for rootless Podman ✅
Support Podman with minimal dependencies, i.e. without container networking (WIP, HELP WANTED)
Legible, minimal bash scripts to be run on system. Put whatever we can into containers!
Feature parity with miniChRIS-docker

System Requirements

Python 3.8 or above
Rootless Podman version 3 or version 4
podman-dnsname (name resolution for containers)

On Arch Linux, please consult the wiki: https://wiki.archlinux.org/title/Podman

Here's what worked for me on 2023-03-17 (possibly helpful, definitely outdated info)

sudo pacman -Syu --needed python podman podman-dnsname
sudo usermod --add-subuids 100000-165535 --add-subgids 100000-165535 $USER

Quick Start

git clone https://github.com/FNNDSC/miniChRIS-podman.git
cd miniChRIS-podman
./minichris.sh

Tear Down

./minichris.sh destroy

Usage

A default superuser chris:chris1234 is created.

website	URL
ChRIS_ui	http://localhost:8020/
ChRIS admin	http://localhost:8000/chris-admin/
ChRIS_store_ui	http://localhost:8021/
Orthanc	http://localhost:8042/

Default Logins

website	username	password
ChRIS	chris	chris1234
ChRIS Store	chris	chris1234
Orthanc	orthanc	orthanc

Network Configuration

To run miniChRIS remotely it is necessary to replace occurrences of localhost with your machine's hostname or IP address in podman-compose.yml.

sed -i -e 's/localhost/my_machines_hostname/' podman-compose.yml
./minichris.sh up

Add Plugins to CUBE

Plugins are added to ChRIS via the Django admin dashboard.

https://github.com/FNNDSC/ChRIS_ultron_backEnd/wiki/%5BHOW-TO%5D-Register-a-plugin-via-Django-dashboard

Alternatively, plugins can be added declaratively. A common use case would be to run locally built Python chris_plugin-based ChRIS plugins. These can be added using chrisomatic by listing their (docker) image tags. For example, if your local image was built with the tag localhost/myself/pl-workinprogress by running

docker build -t localhost/myself/pl-workinprogress .

The bottom of your chrisomatic.yml file should look like

  plugins:
    - name: pl-dircopy
      version: 2.1.1
    - name: pl-tsdircopy
      version: 1.2.1
    - name: pl-topologicalcopy
      version: 0.2
    - name: pl-simpledsapp
      version: 2.1.0
    - localhost/myself/pl-workinprogress

After modifying chrisomatic.yml, apply the changes by running ./chrisomatic.sh

For details, see https://github.com/FNNDSC/chrisomatic#plugins-and-pipelines

Performance

./minichris.sh takes ~60 seconds on a decent laptop (quad-core, 16 GB, SSD) and takes ~3 minutes in Github Actions' Ubuntu VMs. It is strongly recommended that you use an SSD!

rrbanda/miniChRIS-podman-pod