Skip to content

Commit 683383f

Browse files
committed
Remove outdated documentation
1 parent 9f578ff commit 683383f

File tree

1 file changed

+13
-28
lines changed

1 file changed

+13
-28
lines changed

README.md

Lines changed: 13 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![CI badge](https://github.com/FNNDSC/miniChRIS-docker/workflows/CI/badge.svg)](https://github.com/FNNDSC/miniChRIS-docker/actions?query=workflow%3ACI)
44
[![MIT license](https://img.shields.io/github/license/FNNDSC/miniChRIS-docker)](LICENSE)
55

6-
Run a demo of ChRIS. https://chrisproject.org/
6+
Run a demo of _ChRIS_. https://chrisproject.org/
77

88
## Abstract
99

@@ -28,9 +28,12 @@ on how to run development environments for the latest versions.
2828

2929
#### Which ChRIS???
3030

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.
3437
3538
### System Requirements
3639

@@ -70,7 +73,6 @@ Orthanc | http://localhost:8042/
7073
website | username | password
7174
-------------|----------|----------
7275
ChRIS | chris | chris1234
73-
Orthanc | orthanc | orthanc
7476

7577
### Start
7678

@@ -94,20 +96,10 @@ Orthanc | orthanc | orthanc
9496

9597
Try `docker compose down -v --remove-orphans`.
9698

97-
### Network Configuration
98-
99-
To run _miniChRIS_ remotely it is necessary to replace occurrences of `localhost` with your machine's hostname or IP address in `docker-compose.yml`.
100-
101-
```shell
102-
sed -i -e 's/localhost/my_machines_hostname/' docker-compose.yml
103-
docker compose up -d
104-
```
105-
10699
### Add Plugins to CUBE
107100

108101
Plugins are added to _ChRIS_ via the Django admin dashboard.
109-
110-
https://github.com/FNNDSC/ChRIS_ultron_backEnd/wiki/%5BHOW-TO%5D-Register-a-plugin-via-Django-dashboard
102+
Documentation: https://chrisproject.org/docs/tutorials/upload_plugin#using-the-django-dashboard
111103

112104
Alternatively, plugins can be added declaratively.
113105
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
139131

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

142-
# Github Actions
134+
## Github Actions
143135

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
146138
for the purpose of end-to-end testing.
147139

148140
```yaml
@@ -213,7 +205,7 @@ jobs:
213205
- [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.
214206
- [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.
215207

216-
# About _miniChRIS_
208+
## About _miniChRIS_
217209

218210
### Goals
219211

@@ -227,13 +219,6 @@ jobs:
227219

228220
### Performance
229221

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)
231223
and takes 2-3 minutes in [Github Actions' Ubuntu VMs](https://github.com/FNNDSC/miniChRIS/actions).
232224

233-
## Development
234-
235-
You can use hasura-cli on the metal like this:
236-
237-
```shell
238-
env HASURA_GRAPHQL_ENDPOINT=http://localhost:8090 hasura --help
239-
```

0 commit comments

Comments
 (0)