Skip to content

Commit b53b7c0

Browse files
committed
update readme with instructions
1 parent bb7048f commit b53b7c0

File tree

1 file changed

+35
-6
lines changed

1 file changed

+35
-6
lines changed

README.md

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The secure, cloud-based service for the semi-automated mapping of entire session
1313

1414
### About
1515

16-
This is the repository for a semi-supervised web-service for converting neuroimaging data files to [BIDS](https://bids.neuroimaging.io/). The web service is securely hosted at [brainlife.io/ezbids](https://brainlife.io/ezbids). For additional details on security feaures, please see [here](https://brainlife.io/docs/using_ezBIDS/#faq).
16+
This is the repository for a semi-supervised web-service for converting neuroimaging data files to [BIDS](https://bids.neuroimaging.io/). This specific repository exists for users wishing to deploy this web service on premise.
1717

1818
Unlike other BIDS converters, ezBIDS eliminates the need for coding and command line interfaces (CLI), doing the bulk of the work behind the scenes to save users time. Importantly, ezBIDS does not require an organizational structure for uploaded data.
1919

@@ -32,19 +32,48 @@ Helpful links:
3232

3333
### Usage
3434

35-
To access the ezBIDS web service, please visit https://brainlife.io/ezbids. If you do not have a brainlife.io account, you will be prompted to create one for authentication purposes.
36-
3735
Users do not need to organize their uploaded data in any specific manner, and users may choose to compress (e.g. zip, tar) their uploaded data.
3836

3937
Should users feel the need to anonymize data before uploading, we strongly recommend that subjects (and sessions, if applicable) be organized into subject (and session) folders, with explicit labeling of the preferred subjects (and sessions) IDs (e.g. `MRI_data/sub-01/ses-01/DICOMS`). Failure to do so for non-anonymized data may result in an inaccurate *first guess* and require additional edits in the web browser.
4038

4139
#### Local Usage
4240

43-
There are two methods for deploying this service one for local use and another using nginx for sitewide deployments.
41+
There are three methods for deploying this service one for local use, another using nginx for sitewide deployments, and an apptainer option for local use
42+
where docker is unavailable.
43+
44+
For users that can are not setting this service up for others it's recommended to run without nginx. Additionally, for impermanent deployments
45+
users can be up and running with 1 command and no other configuration:
46+
47+
```bash
48+
docker compose up
49+
# or to hide the output
50+
docker compose up -d
51+
```
52+
53+
**Apptainer Use**
54+
55+
The apptainer image must be built from the `EverythingDockerfile`, which is in turn dependent on the images defined/tagged in `docker-compose.yml` being
56+
built. To create the apptainer image one must do the following:
57+
58+
```bash
59+
git clone https://github.com/openneuropet/ezbids_docker.git
60+
cd ezbids_docker
61+
docker compose build
62+
docker build -f EverythingDockerfile -t ezbids-everything .
63+
```
64+
65+
Then the run the following apptainer commands:
66+
```bash
67+
apptainer build ezbids-everything.sif docker-daemon://ezbids-everything:latest
68+
apptainer run --fakeroot --writable-tmpfs --cleanenv --no-home ezbids-everything.sif
69+
```
70+
71+
It should be noted that apptainer occasionally changes which ports it maps the ezBIDS ui to, but that will be mentioned in the console following
72+
the apptainer run step above.
4473

45-
For users that can are not setting this service up for others it's recommended to run without nginx.
74+
**Back to Docker**
4675

47-
In either case, the initial setup requires configuring the local environment via
76+
For a sitewide deployment, the initial setup requires configuring the local environment via
4877
a `.env` file. The first steps are to copy the `example.env` file in this repo
4978
to `.env`:
5079

0 commit comments

Comments
 (0)