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
Copy file name to clipboardExpand all lines: README.md
+35-6Lines changed: 35 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ The secure, cloud-based service for the semi-automated mapping of entire session
13
13
14
14
### About
15
15
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.
17
17
18
18
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.
19
19
@@ -32,19 +32,48 @@ Helpful links:
32
32
33
33
### Usage
34
34
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
-
37
35
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.
38
36
39
37
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.
40
38
41
39
#### Local Usage
42
40
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:
0 commit comments