Skip to content

Commit 377cbb5

Browse files
authored
Merge pull request #154 from brainlife/enh/update-user-agreements
feat: added language to support switch of cloud providers
2 parents e936d25 + c32f458 commit 377cbb5

4 files changed

Lines changed: 137 additions & 139 deletions

File tree

docs/aup.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,3 @@ The user agrees to add the following reference to any publication resulting from
6161
Papers, book chapters, books, posters, oral presentations, and all other printed and digital presentations of results derived from data, data derivatives, analysis code, software or data processing served via brainlife.io should contain the following wording in the acknowledgments section.
6262

6363
> "This publication benefitted at least in part from the use of data or technology provided by brainlife.io (NSF BCS 1734853 to Franco Pestilli)."
64-
65-
66-
#### The brainlife.io team

docs/privacy.md

Lines changed: 29 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,23 @@ Because Internet technologies continue to evolve rapidly, brainlife.io may make
1919

2020
brainlife.io allows you to upload neuroimaging data and store them on your project. All data stored in public projects can be accessed by brainlife.io users, and data stored in private projects can be accessed by the project members. User can also choose to publish data on private project through brainlife publications.
2121

22-
The ownership of all data uploaded, stored on brainlife.io remains with the original owner of the data and retains all copyright and license attributes. The data generated within brainlife.io would belong to the project members.
22+
The ownership of all data uploaded, stored on brainlife.io remains with the original owner of the data and retains all copyright and license attributes. The data generated within brainlife.io would belong to the project members.
2323

24-
brainlife.io allows administrators to access uploaded and generated data-objects stored in private projects when users request for troubleshooting or for investigating suspicious activities and other limited occasions.
24+
brainlife.io allows administrators to access uploaded and generated data-objects stored in private projects when users request for troubleshooting or for investigating suspicious activities and other limited occasions.
2525

2626
### Data Security
2727

28-
The archive data is currently stored on [OSiRIS](https://www.osris.org/), the NSF founded distributed storage infrastructure. We are also exploring the use of [OSN](https://www.openstoragenetwork.org) in the coming months. Only the brainlife administrator is authorized to access these storage systems, however, administrators of these storage systems may have access to the data.
28+
We may use trusted third-party cloud and infrastructure providers to host, process, secure, and maintain data. These providers may change over time to support operational, security, or technical requirements.
2929

30-
brainlife.io provides their users several *shared* computing resources including brainlife.io's own slurm clusters running on Jetstream, and various other [ACCESS](https://access-ci.org/) resources. These shared resources are enabled to all users by default, and when you submit jobs on brainlife, the data must be transferred to these remote computing resources. The data transfer between resources is encrypted by ssh/sha2 protocol with ssh keys encrypted by PBKDF2/sha512 algorithm.
30+
The archive data is currently stored on third party cloud platforms including [OSiRIS](https://www.osris.org/) and [AWS (Amazon Web Services)](https://registry.opendata.aws/apex/) ("AWS"). Only the brainlife administrator(s) is/are authorized to access these storage systems; however, administrators of these storage systems may have access to the data.
3131

32-
The staged data and any data derivatives generated by Apps may be persisted up to 30 days (or shorter) on remote resources during which the administrators of those resources may have access to the data. All shared resources uses a single login account ("brlife") and only the brainlife service (amaretti) and the platform administrators have access to this account. brainlife platform then allows authorized users access to the data that belongs to the projects.
32+
brainlife.io provides their users several _shared_ computing resources including brainlife.io's own slurm clusters running on Jetstream, various [ACCESS](https://access-ci.org/) resources, AWS resources, and other trusted compute resource providers. These shared resources are enabled to all users by default, and when you submit jobs on brainlife, the data must be transferred to these remote computing resources. The data transfer between resources is encrypted by ssh/sha2 protocol with ssh keys encrypted by PBKDF2/sha512 algorithm.
33+
34+
The staged data and any data derivatives generated by Apps may be persisted up to 30 days (or shorter) on remote resources during which the administrators of those resources may have access to the data. Currently, all shared resources uses a single login account ("brlife") and only the brainlife service (amaretti) and the platform administrators have access to this account. The brainlife platform then allows authorized users access to the data that belongs to the projects.
35+
As brainlife grows as a platform and the underlying technology changes, the above described infrastructure may be subject to change.
3336

3437
For monitoring and auditing information, please see "General Security" below.
38+
3539
### Metadata
3640

3741
brainlife.io will not use user's data to conduct any research activities unless you explicitly give permission to do so, however, we retains the right to collect "metadata" from brainlife.io users, including platform usage, number of contributions to the platform, and apps executed will be used to provide platform functionalities and to advance reproducible neuroscience research. We may also share this metadata anonymously and securely with our partners and collaborators in order to improve the platform functionality and user experience. Data collected from users will be ongoing, as long as you are registered for or actively using the platform. While we do aggregate [personally identifiable information](#activemanualvoluntary-collection), no personally identifiable information will be shared with other entities, organizations, or within our research.
@@ -40,16 +44,16 @@ brainlife.io will not use user's data to conduct any research activities unless
4044

4145
When you view pages on our site, the web server automatically collects certain technical information from your computer and about your connection including:
4246

43-
* your IP address
44-
* the domain name from which you visit our site
45-
* user-specific information on which pages are visited
46-
* aggregate information on pages visited
47-
* the referring website
48-
* the date and time of visit
49-
* the duration of visit
50-
* your browser type
51-
* your screen resolution
52-
* Asset accessed on the platform
47+
- your IP address
48+
- the domain name from which you visit our site
49+
- user-specific information on which pages are visited
50+
- aggregate information on pages visited
51+
- the referring website
52+
- the date and time of visit
53+
- the duration of visit
54+
- your browser type
55+
- your screen resolution
56+
- Asset accessed on the platform
5357

5458
Continued use of our website indicates consent to the collection, use, and disclosure of this information as described in this notice.
5559

@@ -59,9 +63,9 @@ This technical information is retained in detail for up to 180 days.
5963

6064
Other than automatically collected technical information about your visit (described above, or cookies, described below), we may ask you to provide information voluntarily, such as through forms or other manual input—in order to make products and services available to you, to maintain and manage our relationship with you, including providing associated services or to better understand and serve your needs. This information is generally retained as long as you continue to maintain a relationship with us. Your providing this information is wholly voluntary. However, not providing the requested information (or subsequently asking that the data be removed) may affect our ability to deliver the products or service for which the information is needed. Providing the requested information indicates your consent to the collection, use, and disclosure of this information as described in this notice. Information we may actively collect could include:
6165

62-
* the email addresses of those who communicate with us via email
63-
* institution, name, biography and other public user profile information.
64-
* information volunteered by the visitor, such as preferences, survey information and/or site registrations
66+
- the email addresses of those who communicate with us via email
67+
- institution, name, biography and other public user profile information.
68+
- information volunteered by the visitor, such as preferences, survey information and/or site registrations
6569

6670
## Information Used For Contact
6771

@@ -100,21 +104,21 @@ In some cases, we will grant visitors the ability to update or correct inaccurac
100104

101105
Visitors may correct inaccuracies in:
102106

103-
* contact information that we have on file
107+
- contact information that we have on file
104108

105109
Visitors can have this information corrected by:
106110

107-
* sending us email at the listed address
108-
* visiting us at the following URL: brainlife.io
109-
* brainlife.io@gmail.com
111+
- sending us email at the listed address
112+
- visiting us at the following URL: brainlife.io
113+
- brainlife.io@gmail.com
110114

111115
## Disclosure of Information
112116

113117
Other than sharing your information with other appropriate university personnel and units to ensure the quality, functionality, and security of our website, or manage your relationship with us, we will not disclose personally identifiable information about your use of the site except under the following circumstances:
114118

115-
* With your prior written (including email) consent
116-
* When we have given you clear notice that we will disclose information that you voluntarily provide
117-
* With appropriate external parties, such as law enforcement agencies, in order to investigate and respond to suspected violations of law or university policy. Any such disclosures shall comply with all applicable laws and university policies.
119+
- With your prior written (including email) consent
120+
- When we have given you clear notice that we will disclose information that you voluntarily provide
121+
- With appropriate external parties, such as law enforcement agencies, in order to investigate and respond to suspected violations of law or university policy. Any such disclosures shall comply with all applicable laws and university policies.
118122

119123
## General Security
120124

@@ -138,7 +142,6 @@ We will post the policy changes to our website to notify you of these changes an
138142

139143
Visitors may prevent their information from being used for purposes other than those for which it was originally collected by sending us an email at the listed address below.
140144

141-
142145
## Contact Information
143146

144147
If you have questions or concerns about this policy, please contact us.

mkdocs.yml

Lines changed: 90 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -1,110 +1,108 @@
1-
21
site_name: brainlife Documentation
3-
site_author: 'The people of brainlife.io'
2+
site_author: "The people of brainlife.io"
43
site_url: https://brainlife.io/docs
54

65
#
76
# Repository
8-
repo_name: 'brainlife/docs'
9-
repo_url: 'https://github.com/brainlife/docs'
7+
repo_name: "brainlife/docs"
8+
repo_url: "https://github.com/brainlife/docs"
109

1110
copyright: 'Copyright &copy; 2017 - 2022 brainlife.io | Please report issues on <a style="text-decoration: underline;" target="github" href="https://github.com/brainlife/docs/issues">Github Issues</a> or send us your comment at <a style="text-decoration: underline;" target="slack" href="https://brainlife.slack.com/">Slack</a>'
1211

1312
theme:
14-
name: 'material'
15-
language: 'en'
16-
favicon: '/img/favicon.ico'
17-
palette:
18-
primary: 'light blue'
19-
custom_dir: overrides
13+
name: "material"
14+
language: "en"
15+
favicon: "/img/favicon.ico"
16+
palette:
17+
primary: "light blue"
18+
custom_dir: overrides
2019

2120
nav:
22-
- Home: index.md
23-
24-
- ezBIDS: using_ezBIDS.md
25-
26-
- Using brainlife:
27-
- Getting Started: user/started.md
28-
- Projects: user/project.md
29-
- Datatypes: user/datatypes.md
30-
- Archive: user/archive.md
31-
- Preprocess: user/process.md
32-
- Pipelines: user/pipeline.md
33-
- Publications: user/publication.md
34-
- Datasets : user/datasets.md
35-
- Failure: user/failure.md
36-
37-
- Tutorials:
38-
- Introduction: tutorial/introduction-to-brainlife.md
39-
- ezBIDS: tutorial/ezBIDS.md
40-
- Anatomy: tutorial/t1w-preprocessing.md
41-
- AWS: tutorial/aws-brainlife.md
42-
- FMRI Preprocessing: tutorial/fmri-preprocessing-tutorial.md
43-
- PRF Mapping: tutorial/prf-mapping.md
44-
- DWI Preprocessing : tutorial/diffusion-preprocessing.md
45-
- DWI Tractometry: tutorial/diffusion-tractography.md
46-
- Network Neuroscience - Structural: tutorial/networkneuroscience-structural.md
47-
- Network Neuroscience - Functional: tutorial/networkneuroscience-functional.md
48-
- Cortex Tissue Mapping: tutorial/cortex-tissue-mapping.md
49-
- Pipeline Tutorial: tutorial/anat-t1-pipeline-tutorial.md
50-
- Clairvoy: tutorial/using-clairvoy.md
51-
52-
- Using CLI:
53-
- Installation: cli/install.md
54-
- Uploading Data: cli/upload.md
55-
- Running Apps: cli/app.md
56-
- Downloading Data: cli/download.md
57-
- Update Data: cli/update.md
58-
- Group Analysis: cli/group.md
59-
60-
- Developing Apps:
61-
- Introduction: apps/introduction.md
62-
- HelloWorld: apps/helloworld.md
63-
- Registering App: apps/register.md
64-
- Containerizing App: apps/container.md
65-
- Versioning Tips: apps/versioning.md
66-
- Custom Hooks: apps/customhooks.md
67-
- product.json: apps/product.md
68-
- submodules: apps/submodules.md
69-
70-
- Compute Resources:
71-
- Registering Resource: resources/register.md
72-
73-
- Technical:
74-
- Architecture: technical/arthitecture.md
75-
- APIs: technical/api.md
76-
- ezBIDS: technical/ezBIDS.md
77-
78-
- Careers: careers/jobs.md
79-
80-
- Contact: contact.md
81-
- Privacy Policy: privacy.md
82-
- AUP: aup.md
83-
- Media / Branding: media.md
21+
- Home: index.md
22+
23+
- ezBIDS: using_ezBIDS.md
24+
25+
- Using brainlife:
26+
- Getting Started: user/started.md
27+
- Projects: user/project.md
28+
- Datatypes: user/datatypes.md
29+
- Archive: user/archive.md
30+
- Preprocess: user/process.md
31+
- Pipelines: user/pipeline.md
32+
- Publications: user/publication.md
33+
- Datasets: user/datasets.md
34+
- Failure: user/failure.md
35+
36+
- Tutorials:
37+
- Introduction: tutorial/introduction-to-brainlife.md
38+
- ezBIDS: tutorial/ezBIDS.md
39+
- Anatomy: tutorial/t1w-preprocessing.md
40+
- AWS: tutorial/aws-brainlife.md
41+
- FMRI Preprocessing: tutorial/fmri-preprocessing-tutorial.md
42+
- PRF Mapping: tutorial/prf-mapping.md
43+
- DWI Preprocessing: tutorial/diffusion-preprocessing.md
44+
- DWI Tractometry: tutorial/diffusion-tractography.md
45+
- Network Neuroscience - Structural: tutorial/networkneuroscience-structural.md
46+
- Network Neuroscience - Functional: tutorial/networkneuroscience-functional.md
47+
- Cortex Tissue Mapping: tutorial/cortex-tissue-mapping.md
48+
- Pipeline Tutorial: tutorial/anat-t1-pipeline-tutorial.md
49+
- Clairvoy: tutorial/using-clairvoy.md
50+
51+
- Using CLI:
52+
- Installation: cli/install.md
53+
- Uploading Data: cli/upload.md
54+
- Running Apps: cli/app.md
55+
- Downloading Data: cli/download.md
56+
- Update Data: cli/update.md
57+
- Group Analysis: cli/group.md
58+
59+
- Developing Apps:
60+
- Introduction: apps/introduction.md
61+
- HelloWorld: apps/helloworld.md
62+
- Registering App: apps/register.md
63+
- Containerizing App: apps/container.md
64+
- Versioning Tips: apps/versioning.md
65+
- Custom Hooks: apps/customhooks.md
66+
- product.json: apps/product.md
67+
- submodules: apps/submodules.md
68+
69+
- Compute Resources:
70+
- Registering Resource: resources/register.md
71+
72+
- Technical:
73+
- Architecture: technical/arthitecture.md
74+
- APIs: technical/api.md
75+
- ezBIDS: technical/ezBIDS.md
76+
77+
- Careers: careers/jobs.md
78+
79+
- Contact: contact.md
80+
- Privacy Policy: privacy.md
81+
- AUP: aup.md
82+
- Media / Branding: media.md
8483

8584
extra:
86-
#disqus: 'brain-life'
87-
social:
88-
- icon: fontawesome/brands/twitter
89-
link: 'https://twitter.com/BrainLifeio'
90-
- icon: fontawesome/brands/github
91-
link: 'https://github.com/brainlife'
92-
- icon: fontawesome/brands/slack
93-
link: 'https://brainlife.slack.com'
94-
- icon: fontawesome/brands/youtube
95-
link: 'https://youtube.com/brainlifeio'
85+
#disqus: 'brain-life'
86+
social:
87+
- icon: fontawesome/brands/twitter
88+
link: "https://twitter.com/BrainLifeio"
89+
- icon: fontawesome/brands/github
90+
link: "https://github.com/brainlife"
91+
- icon: fontawesome/brands/slack
92+
link: "https://brainlife.slack.com"
93+
- icon: fontawesome/brands/youtube
94+
link: "https://youtube.com/brainlifeio"
9695

9796
extra_css:
9897
- css/narrow.css
9998

10099
markdown_extensions:
101-
- admonition
102-
- footnotes
103-
- toc:
104-
permalink: True
105-
- fontawesome_markdown
106-
- attr_list
107-
- pymdownx.highlight:
108-
linenums: true
109-
- pymdownx.superfences
110-
100+
- admonition
101+
- footnotes
102+
- toc:
103+
permalink: True
104+
- fontawesome_markdown
105+
- attr_list
106+
- pymdownx.highlight:
107+
linenums: true
108+
- pymdownx.superfences

package.json

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
{
2-
"name": "docs",
3-
"version": "1.0.0",
4-
"description": "",
5-
"main": "index.js",
6-
"directories": {
7-
"doc": "docs"
8-
},
9-
"scripts": {
10-
"install": "sudo pip3 install mkdocs mkdocs-material fontawesome_markdown",
11-
"deploy": "echo test.brainlife.io github hook service automatically updates it (test.brainlife.io:/home/hayashis/git/docs - launched by @reboot cron)",
12-
"deploy-prod": "mkdocs build && rsync -av site/ hayashis@brainlife.io:/usr/local/static/docs",
13-
"dev": "mkdocs serve"
14-
},
15-
"author": "",
16-
"license": "ISC",
17-
"dependencies": {
18-
"github-webhook-handler": "^1.0.0"
19-
}
2+
"name": "docs",
3+
"version": "1.0.0",
4+
"description": "",
5+
"main": "index.js",
6+
"directories": {
7+
"doc": "docs"
8+
},
9+
"scripts": {
10+
"install": "sudo pip3 install mkdocs mkdocs-material fontawesome_markdown",
11+
"deploy": "echo test.brainlife.io github hook service automatically updates it (test.brainlife.io:/home/hayashis/git/docs - launched by @reboot cron)",
12+
"deploy-prod": "mkdocs build && rsync -av site/ hayashis@brainlife.io:/usr/local/static/docs",
13+
"dev": "mkdocs serve"
14+
},
15+
"author": "",
16+
"license": "ISC",
17+
"dependencies": {
18+
"github-webhook-handler": "^1.0.0"
19+
}
2020
}

0 commit comments

Comments
 (0)