Skip to content

Commit cf1cc58

Browse files
authored
Merge pull request #259 from cmu-delphi/docs/survey-sftp
Document how to connect to the SFTP server
2 parents 5bc4131 + 6563d48 commit cf1cc58

File tree

6 files changed

+66
-4
lines changed

6 files changed

+66
-4
lines changed
Loading
Loading
Loading
Loading

docs/symptom-survey/server-access.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: SFTP Server Access
3+
parent: COVID Symptom Survey
4+
nav_order: 4
5+
---
6+
7+
# SFTP Server Access
8+
9+
Researchers with data use agreements to access the raw data from the COVID-19
10+
symptom survey can access the data over SFTP. (If you do not have a data use
11+
agreement, see the [main survey page](index.md) for information about getting
12+
access.)
13+
14+
If you're not familiar with SFTP, it is a protocol for securely accessing and downloading
15+
large amounts of data from remote servers. The instructions below explain how to
16+
connect to our SFTP server on Windows or Mac. (Linux users can use the
17+
command-line `sftp` program, or most file managers can browse directly to
18+
`sftp://ftp.delphi.cmu.edu:2222` using the username and password provided to
19+
you.)
20+
21+
## Windows
22+
23+
[WinSCP](https://winscp.net/eng/index.php) is a free, open source SFTP client
24+
for Windows. (You can use other SFTP clients if you already have one you
25+
prefer.)
26+
27+
1. Download and install WinSCP.
28+
29+
2. When you open WinSCP, a login window should appear, at which point you can
30+
move to Step 3. If not, click the “New Session” button in the top left.
31+
32+
![Screenshot of WinSCP's opening screen.](screenshots/winscp-small1.png)
33+
34+
3. In the login window, make sure SFTP is the selected file protocol and input
35+
the credentials (server, user, password, and port) given to you in the “CMU
36+
Delphi COVID Survey Data Access” email. Click “Login” to connect.
37+
38+
![Screenshot of WinSCP's credentials and login screen.](screenshots/winscp-small2.png)
39+
40+
4. You should then have access to the CSV files of individual responses from CMU
41+
Delphi COVID Survey of Facebook users. See our [response files documentation](survey-files.md)
42+
for information on how these files are formatted.
43+
44+
## MacOS
45+
46+
[Cyberduck](https://cyberduck.io) is a free, open source SFTP client for MacOS.
47+
(Download directly from their site for free; the App Store version costs $24.)
48+
49+
1. Once the program is installed, click “Open Connection”.
50+
51+
![Screenshot of Cyberduck's opening screen.](screenshots/cyberduck-1.png)
52+
53+
2. Select SFTP (SSH File Transfer Protocol) and input the credentials given to
54+
you (server, user, password, and port) in the “CMU Delphi COVID Survey Data
55+
Access” email.
56+
57+
![Screenshot of Cyberduck's screen to enter credentials.](screenshots/cyberduck-2.png)
58+
59+
3. You should then have access to the CSV files of individual responses from CMU
60+
Delphi COVID Survey of Facebook users. See our [response files documentation](survey-files.md)
61+
for information on how these files are formatted.

docs/symptom-survey/survey-files.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,10 @@ nav_order: 1
77
# Response Files
88
{: .no_toc}
99

10-
Users with access to the [COVID symptom survey](./index.md) individual response data
11-
should have received SFTP credentials for a private server where the data are
12-
stored. This documentation describes the survey data available on that server.
10+
Users with access to the [COVID symptom survey](./index.md) individual response
11+
data should have received SFTP credentials for a private server where the data
12+
are stored. To connect to the server, see the [server access documentation](server-access.md).
13+
This documentation describes the survey data available on that server.
1314

1415
You must sign a Data Use Agreement with Facebook and with CMU to gain
1516
access to the individual survey responses. If you have not done so, aggregate data is available
@@ -44,7 +45,7 @@ Every day, we write response files for *all* days of data, with today's
4445
`recorded` date. You need only load the most recent set of `recorded` files to
4546
obtain all survey responses; the older versions are available to track any
4647
changes in file formats or slight changes from late-arriving responses, as
47-
described in the lag policy.
48+
described in the [lag policy below](#lag-policy).
4849

4950
## Conditions Responses are Recorded
5051

0 commit comments

Comments
 (0)