You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -28,9 +28,12 @@ on how to run development environments for the latest versions.
28
28
29
29
#### Which ChRIS???
30
30
31
-
-_miniChRIS-docker_ is the easiest, fastest, and most portable way to run _ChRIS_.
32
-
-[_miniChRIS-podman_](https://github.com/FNNDSC/miniChRIS-podman) uses rootless Podman to run _ChRIS_.
33
-
-[ChRIS_ultron_backEnd/make.sh](https://github.com/FNNDSC/ChRIS_ultron_backEnd) runs the _ChRIS_ backend in development mode with pman on Docker swarm and optionally runs integration tests.
31
+
-_miniChRIS-docker_ is the easiest, fastest, and most portable way to run a "demo" of _ChRIS_.
32
+
-[ChRIS_ultron_backEnd](https://github.com/FNNDSC/ChRIS_ultron_backEnd) runs the _ChRIS_ backend in development mode and works with either Docker or Podman.
33
+
-[fnndsc/charts](https://chrisproject.org/docs/run/helm) Helm repository is for production.
34
+
35
+
> [!CAUTION]
36
+
> _miniChRIS_ is not suitable for production. It contains hard-coded secrets and insecure defaults.
Alternatively, plugins can be added declaratively.
113
105
A common use case would be to run locally built Python
@@ -139,10 +131,10 @@ After modifying `chrisomatic.yml`, apply the changes by rerunning `./minichris.s
139
131
140
132
For details, see https://github.com/FNNDSC/chrisomatic#plugins-and-pipelines
141
133
142
-
# Github Actions
134
+
## Github Actions
143
135
144
-
*miniChRIS* can be used as a step in Github Actions workflows to spin up
145
-
an ephermeral instance of the ChRIS backend and its ancillary services
136
+
*miniChRIS* can be used as a step in GitHub Actions workflows to spin up
137
+
an ephemeral instance of the ChRIS backend and its ancillary services
146
138
for the purpose of end-to-end testing.
147
139
148
140
```yaml
@@ -213,7 +205,7 @@ jobs:
213
205
- [FNNDSC/cookicutter-chrisapp/.github/workflows/test.yml](https://github.com/FNNDSC/cookiecutter-chrisapp/blob/16db74860e8201f3d201183961eadc39116ce8a7/.github/workflows/test.yml#L31) uses _mihiChRIS_ for end-to-end testing.
214
206
- [FNNDSC/cni-store-proxy/package.json](https://github.com/FNNDSC/cni-store-proxy/blob/master/package.json) uses _miniChRIS_ as a git submodule for a local dev environment.
215
207
216
-
# About _miniChRIS_
208
+
## About _miniChRIS_
217
209
218
210
### Goals
219
211
@@ -227,13 +219,6 @@ jobs:
227
219
228
220
### Performance
229
221
230
-
`./minichris.sh`takes 30-60 seconds on a decent laptop (quad-core, 16 GB, SSD)
222
+
`./minichris.sh`takes 30-60 seconds on a decent laptop (quad-core, 8GB memory, SSD)
231
223
and takes 2-3 minutes in [Github Actions' Ubuntu VMs](https://github.com/FNNDSC/miniChRIS/actions).
0 commit comments