Deprecated: see https://github.com/FNNDSC/miniChRIS-podman
This project is succeeded by miniChRIS-k8s,
which supports Podman via podman kube play.
miniChRIS-podman-compose provides a single YAML file which can be read by podman-compose to run all of ChRIS.
Image tags are pinned to stable versions, so miniChRIS might be out-of-date with development versions of ChRIS components. To run ChRIS components in development mode, see their respective Github repositories.
See also: https://github.com/FNNDSC/miniChRIS-docker
miniChRIS-podman-compose requires Podman version 3 or 4. We aim to support "out-of-the-box" setups of rootless Podman.
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 $USERgit clone https://github.com/FNNDSC/miniChRIS-podman.git
cd miniChRIS-podman
./minichris.sh./minichris.sh destroyidk, ask Jennings... https://matrix.to/#/@jennydaman:fedora.im
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/ |
| website | username | password |
|---|---|---|
| ChRIS | chris | chris1234 |
| ChRIS Store | chris | chris1234 |
| Orthanc | orthanc | orthanc |
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 upPlugins are added to ChRIS via the Django admin 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-workinprogressAfter modifying chrisomatic.yml, apply the changes by running ./chrisomatic.sh
For details, see https://github.com/FNNDSC/chrisomatic#plugins-and-pipelines
./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!