Skip to content

Commit bd34fe8

Browse files
Provide documentation for raw data upload by external submitters (#46)
* Provide documentation on how to request access and upload data as an external data submitter. # Co-authored-by: KochTobi <[email protected]> * Fix missing images and renaming * Streamline documentation and fix minor mistakes * Update What's new Section * Slim Update Title * Typo
1 parent 56c4c63 commit bd34fe8

12 files changed

+156
-32
lines changed

docs/get_started/process_overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
3. Specify the [experimental design](../experiment/experiment_introduction.md)
66
4. Register [Sample Batches](../batch/sample-batch.md)
77
5. Specify the performed [measurements](../measurement/measurement_introduction.md)
8-
6. Upload your [raw data](../rawdata/raw_data_upload.md).
8+
6. Upload your [raw data](../rawdata/raw_data_request_server_access.md).
99
7. Fine tune the accessibility of your project to [collaborators](../project/project_access.md)!
1010
8. Share your measurement data [easily](../rawdata/raw_data_download.md)

docs/index.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,25 @@ the [Data Manager](https://rdm.qbic.uni-tuebingen.de/login) platform early on in
66

77
## What's new?
88

9+
### Data Submission from outside the University Tübingen network
10+
11+
<div style="font-size: smaller; color: rgba(122,122,122,1)">October 10th, 2025 </div>
12+
13+
- External Data Submission: Check out how
14+
to [request access ](rawdata/raw_data_request_server_access.md)
15+
and [submit your data](rawdata/raw_data_upload.md) from outside the University Tübingen network
16+
- Orcid Linkage documentation: Learn how to [link your orcid account](user/user_edit.md#link-orcid)
17+
within the data manager
18+
19+
## Update history
20+
921
### Orcid Linkage and Template Registration Overhaul
1022

1123
<div style="font-size: smaller; color: rgba(122,122,122,1)">September 18th, 2025 </div>
1224

13-
📌 Checkout the complete [release notes](https://github.com/qbicsoftware/data-manager-app/releases/tag/1.11.0) on GitHub.
25+
📌 Checkout the
26+
complete [release notes](https://github.com/qbicsoftware/data-manager-app/releases/tag/1.11.0) on
27+
GitHub.
1428

1529
💡 Highlights:
1630

@@ -30,16 +44,13 @@ the [Data Manager](https://rdm.qbic.uni-tuebingen.de/login) platform early on in
3044
- Download Urls for filtered raw data: Triggering the download of dataset URLS provides only the
3145
URLs of the filtered dataset
3246

33-
## Update history
34-
3547
### Metadata Examples and Descriptions
3648

3749
<div style="font-size: smaller; color: rgba(122,122,122,1)">September 18th, 2025 </div>
3850

3951
- Glossary: Introduction of a glossary explaining the terms with example values in the research data
4052
management documentation. Check it out [here](metadata/concepts.md)
4153

42-
4354
### Enable Asynchronous Sample and Experiment Update
4455

4556
<div style="font-size: smaller; color: rgba(122,122,122,1)">June 10th, 2025 </div>

docs/metadata/concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ registration [template sheet](templates/proteomics_measurement_registration_shee
269269

270270
### Raw Data
271271

272-
Visit our documentation to find out how to [upload](../rawdata/raw_data_upload.md)
272+
Visit our documentation to find out how to [upload](../rawdata/raw_data_request_server_access.md)
273273
or [download](../rawdata/raw_data_download.md) your raw data.
274274

275275
The following concepts are associated with a raw data dataset.
249 KB
Loading

docs/rawdata/raw_data_download.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Raw Data Introduction
22

3-
The raw data summary view shows detailed information about the raw data already [registered](raw_data_upload.md) for the measurements within your experiment.
3+
The raw data summary view shows detailed information about the raw data already [registered](raw_data_request_server_access.md) for the measurements within your experiment.
44
Additionally, it enables you to generate the [URLs](#raw-data-url-generation) necessary
55
to start the command line based [raw data download](#download-raw-data).
66

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Request Server Access
2+
3+
This section gives an overview on how to request access to our upload server to submit data from outside of the University Tübingen network.
4+
5+
!!! tip
6+
Should you be a member of the university of Tübingen you can immediately [upload your data](raw_data_upload.md) and skip this process.
7+
8+
## Prerequisites
9+
10+
- An `ed25519` encrypted public and private keypair on the connecting machine
11+
- The static and public `IPv4` address of the connecting machine
12+
- The name and affiliation of the data submitting party
13+
14+
## Procedure
15+
16+
To minimize security risk, access to our upload server is restricted to temporary whitelisted IP addresses from outside of the university network.
17+
!!! note
18+
Please make sure to provide a **public** and **static** IP address from the machine you want to connect from.
19+
Check with your IT department on details on how to obtain such an IP address.
20+
21+
As an additional security layer, data submitters have to authenticate using [strong cryptographic keys](#generate-cryptographic-keys).
22+
Once these technical details are resolved, feel free to contact us to [request access to our server](#get-in-contact)
23+
24+
### Generate Cryptographic Keys
25+
26+
For account creation a public key is required. Please generate an ssh keypair via your system specific command and make sure to specify your email address:
27+
28+
=== "Linux"
29+
30+
Open your terminal
31+
``` bash
32+
ssh-keygen -t ed25519 -a 420 -f ~/.ssh/qbic-upload.ed25519 -C "<[email protected]>"
33+
```
34+
35+
=== "MacOS"
36+
37+
Open Terminal [as described by Apple](https://support.apple.com/guide/terminal/open-or-quit-terminal-apd5265185d-f365-44cb-8b09-71a064a42125/mac)
38+
``` bash
39+
ssh-keygen -t ed25519 -a 420 -f ~/.ssh/qbic-upload.ed25519 -C "<[email protected]>"
40+
```
41+
42+
=== "Windows"
43+
44+
Open PowerShell [as described by Microsoft](https://learn.microsoft.com/en-us/powershell/scripting/windows-powershell/starting-windows-powershell?view=powershell-7.5#run-from-the-start-menu)
45+
``` bash
46+
ssh-keygen -t ed25519 -a 420 -f $HOME/.ssh/qbic-upload.ed25519 -C "<[email protected]>"
47+
```
48+
49+
with the name `qbic-upload.ed25519` and a public key named `qbic-upload.ed25519.pub` within your `.ssh` directory.
50+
51+
### Get in Contact
52+
53+
After you have [generated your ssh key](#generate-cryptographic-keys) and setup a public static IP address,
54+
please write an email to [[email protected]](mailto:[email protected]) and attach the public (.pub) key file similar to the provided template:
55+
56+
!!! warning
57+
Make sure you **only** send us the public key file ending with .pub
58+
59+
**Do not send us the private key!**
60+
61+
```txt
62+
Dear QBiC Team
63+
64+
I would like to upload measurement data to your data manager.
65+
Can you please provide me with an account on your upload server.
66+
67+
Below you can find the requested information
68+
69+
Name: <Max Mustermann>
70+
71+
Affiliation: <My Research Institute>, <https://ror.org/03a1kwz48>
72+
Project: <Q2EXAMPLE>
73+
Access Duration: 30 days
74+
75+
IP-Address: <Your static public IPV4 Adress>
76+
For accessing your upload server I would like to use the attached key.
77+
78+
Attachments: qbic-upload.ed25519.pub
79+
```
80+
81+
### Wait for a reply
82+
After you have [established contact](#get-in-contact) with our support team,
83+
we will create an account for you on our upload server and contact you with confirmation and your assigned username.
84+
85+
!!! note
86+
Please note down the username as this will be the username you will use to connect to our upload server.
87+
88+
### Proceed by [uploading data](raw_data_upload.md)

docs/rawdata/raw_data_upload.md

Lines changed: 49 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,26 @@
33
After creating measurements in the Data Manager, you can upload measured data to our platform.
44
This section gives an overview on how to upload data to measurements from QBiC's Data Manager.
55

6+
!!! info
7+
If you are not a member of the University of Tübingen, please [request access as a data submitter](raw_data_request_server_access.md)
8+
69
## Prerequisites
710

8-
The following is required in order to successfully execute the measurement data upload.
11+
The following is required in order to successfully execute the measurement data upload dependent on your affiliation.
12+
13+
=== "University Tübingen member"
14+
- A connection to the University Of Tübingen network (
15+
e.g. [using the University VPN](https://uni-tuebingen.de/en/facilities/zentrum-fuer-datenverarbeitung/services/network-services/network-access/remote-access-vpn/))
16+
- An LDAP account of the University Of Tübingen
17+
- Access to the project of interest
18+
- OpenSSH package or a SFTP **client** software (e.g. [FileZilla](https://filezilla-project.org/download.php?type=client)
19+
or [WinSCP](https://winscp.net))
920

10-
- A connection to the University Of Tübingen network (
11-
e.g. [using the University VPN](https://uni-tuebingen.de/en/facilities/zentrum-fuer-datenverarbeitung/services/network-services/network-access/remote-access-vpn/))
12-
- An LDAP account of the University Of Tübingen
13-
- Access to the project of interest
14-
- OpenSSH package or a SFTP **client** software (e.g. [FileZilla](https://filezilla-project.org/download.php?type=client)
15-
or [WinSCP](https://winscp.net))
21+
=== "External data submitter"
22+
- [Granted access and authorization to our upload server](raw_data_request_server_access.md)
23+
- Access to the project of interest
24+
- OpenSSH package or a SFTP **client** software (e.g. [FileZilla](https://filezilla-project.org/download.php?type=client)
25+
or [WinSCP](https://winscp.net))
1626

1727
## Process Overview
1828

@@ -132,10 +142,19 @@ measurement data registration, select `SFTP - SSH File Transfer Protocol` and
132142
enter `upload.qbic.uni-tuebingen.de` into the `Host` field.
133143
![An image showing the users site manager highlighting the host and connection field](images/upload/raw_data_upload_site_manager_host-fields.png){.screenshot}
134144

135-
You can log in with your _University of Tübingen_ credentials. Enter your university user account
136-
into the `User` field.
137-
![An image showing the users site manager highlighting the user and password field](images/upload/raw_data_upload_site_manager_credential-fields.png){.screenshot}
138-
**Connect to the server:** Make sure you are in the network of the _University of Tübingen_. You can connect to the server by pressing `Connect` in
145+
Afterwards, choose the affiliation dependent login method to connect to our upload server.
146+
147+
=== "University Tübingen member"
148+
Login with your _University of Tübingen_ credentials. Enter your university provided username
149+
into the `User` field.
150+
![An image showing the users site manager highlighting the user and password field](images/upload/raw_data_upload_site_manager_credential-fields.png){.screenshot}
151+
152+
=== "External data submitter"
153+
Login with your username and key file. Enter your username
154+
into the `User` field and select your private key file from within your local `.ssh` directory by pressing the browse button.
155+
![An image showing the users site manager highlighting the user field](images/upload/raw_data_upload_site_manager_submitter_credential_fields.png){.screenshot}
156+
157+
**Connect to the server:** You can connect to the server by pressing `Connect` in
139158
the _Site Manager_. After connecting to the server, _FileZilla_ shows you the contents of your home directory on the server side.
140159
![An image showing the users home folder. You can see three directories named registration, error and upload.](images/upload/raw_data_upload_remote_filesystem.png){.screenshot}
141160
!!! warning
@@ -165,38 +184,43 @@ The OpenSSH SFTP program is supported natively by most operating systems.
165184
In this section we will go through the process of connecting to our server
166185
using the [OpenSSH SFTP](https://man.openbsd.org/sftp) program.
167186

187+
!!! note
188+
This section requires commandline knowledge within your operating system.
189+
We recommend to get in contact with your local IT department should you need assistance
190+
or upload your data via a [dedicated sftp client](#upload-your-dataset-via-sftp-client)
191+
168192
### Install OpenSSH SFTP
169193

170194
#### Linux/Mac
171195
Linux and Mac systems do typically have the OpenSSH package containing SFTP pre-installed.
172196
Should this not be the case, try to install the openSSH package with the package manager employed by your system.
173-
We recommend to get in contact with your local IT department should you need assistance.
174197

175198
#### Windows
176199
Newer Windows Versions (Windows10 version 1803 and newer and Windows 11) do typically have the OpenSSH package containing SFTP preinstalled.
177-
Should this not be the case, check your system settings to see if the **OpenSSH server feature** is installed within the windows optional features.
178-
We recommend to get in contact with your local IT department should you need assistance.
200+
Should this not be the case, check your system settings to see if the **OpenSSH server feature** is installed within the windows optional features.
179201

180202
### Connect and upload your dataset
181203

182-
!!! note
183-
This section requires basic command line knowledge of your operating system.
204+
!!! tip
205+
184206
Check the OpenSSH sftp [manpage](https://man.openbsd.org/sftp) for information on how to use the sftp program.
185207

186208
Start by opening the command line within your operating system of choice.
187209
Next navigate to the local working directory containing the dataset you wish to upload.
188-
From within this directory connect to our upload server with the **sftp** command, replacing <your-user> with your university account credentials:
210+
From within this directory connect to our upload server with the **sftp** command, replacing <your-user> with your university account credentials
211+
or tbe username granted to you after [requesting access](raw_data_request_server_access.md) to our upload server from outside the university network:
189212

190-
``` bash
191-
sftp <your-user>@upload.qbic.uni-tuebingen.de
192-
```
193-
Upon successful connection you will be prompted for your university account password.
213+
=== "External Data Submitter"
214+
``` bash
215+
sftp -i <your private key file> <username>@upload.qbic.uni-tuebingen.de
216+
```
194217

195-
!!! Warning
196-
Keep in mind that you need to be within the university network and
197-
have a valid university account to connect to our upload server
218+
=== "University Tübingen Member"
219+
``` bash
220+
sftp <username>@upload.qbic.uni-tuebingen.de
221+
```
198222

199-
If everything goes well, you'll be connected to the remote working directory within our upload server.
223+
If everything goes well, you'll be connected to your remote home directory within our upload server.
200224
You can check out the directory structure of this directory with the following **ls** command:
201225

202226
``` bash
39 KB
Loading
45.1 KB
Loading
110 KB
Loading

0 commit comments

Comments
 (0)