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: lang/en/docs/remote-connection/actions/transfer-files-scp.md
+18-7Lines changed: 18 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,30 +1,41 @@
1
1
# Transfer Files via SCP
2
2
3
-
[SCP file transfers](../../remote-connection/ssh.md#transfer-files-with-scp) can be performed directly via any terminal instance opened in a local user machine running a Unix-based operating system, through the following commands (the user should replace the text inside braces below with the corresponding names/paths).
3
+
[SCP file transfers](../../remote-connection/ssh.md#transfer-files-with-scp) can
4
+
be performed directly via any terminal instance opened in a local user machine
5
+
with OpenSSH client installed, through the following commands (the user should
6
+
replace the text inside braces below with the corresponding names/paths).
4
7
5
-
1. To transfer local files **to**exabyte.io remote server (called "bohr"):
8
+
1. To transfer local files **to**mat3ra.com remote server (called "bohr"):
6
9
7
10
```bash
8
11
scp -i <path to private_key><path to local file><username>@login.mat3ra.com:<path inside login home>
9
12
```
10
13
11
-
2. To transfer remote files **from**exabyte.io server to local machine:
14
+
2. To transfer remote files **from**mat3ra.com server to local machine:
12
15
13
16
```
14
17
scp -i <path to private_key> <username>@login.mat3ra.com:<path inside login home> <path to local file>
15
18
```
16
19
17
20
## Examples
18
21
19
-
For example, let us assume that user `steve` would like to transfer a text file called `example.txt` under his local home directory to the remote "bohr" server, where the final destination is his personal `data` folder in the [Cluster Home](../../infrastructure/clusters/directories.md) directory for "cluster-001".
20
-
21
-
The command that he needs to enter to perform this file transfer, after opening a terminal instance on his own local machine, would be the following (assuming his private [ssh key](../ssh.md) file is stored locally under his home folder).
22
+
For example, let us assume that user `steve` would like to transfer a text file
23
+
called `example.txt` under his local home directory to the remote "bohr" server,
24
+
where the final destination is his personal `data` folder in the
25
+
[Cluster Home](../../infrastructure/clusters/directories.md) directory for
26
+
"cluster-001".
27
+
28
+
The command that he needs to enter to perform this file transfer, after opening
29
+
a terminal instance on his own local machine, would be the following (assuming
30
+
his private [ssh key](../ssh.md) file is stored locally under his home folder).
The converse operation, to retrieve the remotely stored `example.txt` file and re-copy it under his local home directory, would consist in the following command.
36
+
The converse operation, to retrieve the remotely stored `example.txt` file and
37
+
re-copy it under his local home directory, would consist in the following
The user can connect to the [Command Line Interface](../cli/overview.md) (CLI) of our platform using an **external SSH terminal client** under any Operating System (OS), as an alternative to the [Web Terminal](web-terminal.md).
4
-
5
-
We use **SSH keys**[^1] as a way to identify users and trusted computers during command line sessions. Keys provide improved security, however they need to be set properly before use. The steps included in the present page will guide the user through generating SSH keys and adding them to the account being employed.
6
-
7
-
Experienced users who are already familiar with how SSH clients operate under their preferred Operating System can navigate directly to the [Upload SSH key](#upload-ssh-key) section of the present page.
8
-
9
-
## OS-specific SSH Clients
10
-
11
-
We particularly recommend the following SSH clients for each OS.
12
-
13
-
-**Putty**[^2], a widespread SSH client for Windows.
14
-
-**OpenSSH**[^3], the standard protocol in Unix-based OSs (both Linux and Mac OS distributions) for connecting through SSH via the terminal.
3
+
Users can connect to the [Command Line Interface](../cli/overview.md) (CLI)
4
+
of our platform using an **SSH terminal client** under any Operating System
5
+
(OS), as an alternative to the [Web Terminal](web-terminal.md).
6
+
7
+
We use **SSH keys**[^1] to identify users and trusted computers during command
8
+
line sessions. Keys provide improved security, but they must be properly set up
9
+
before use. The steps on this page will guide you through generating SSH keys
10
+
and adding them to your account.
11
+
12
+
Experienced users who are already familiar with how SSH clients operate under
13
+
their preferred Operating System can navigate directly to the
14
+
[Upload SSH key](#upload-ssh-key) section below.
15
+
16
+
## SSH Client
17
+
18
+
Make sure you have a SSH client installed in your computer. We particularly
19
+
recommend the following SSH clients.
20
+
21
+
-**OpenSSH**[^2]: the standard protocol in Unix-based OSs (both Linux and
22
+
macOS distributions) for connecting through SSH via the terminal. <br/>Starting
23
+
from Windows version 10, OpenSSH client is included as a Windows Feature. Please
24
+
expand below section if OpenSSH is not enabled on your Windows computer. Once
25
+
enabled, both `ssh` and `scp` commands should be available via both
26
+
**PowerShell** and **Command Prompt**.
27
+
<detailsmarkdown="1">
28
+
<summary>
29
+
How to enable OpenSSH on Windows 10?
30
+
</summary>
31
+
1. Click on the Windows **Start menu** and search for **Apps and Features**.
32
+
Click on **Apps and Features** on the sidebar, then click **Optional
33
+
Features**.
34
+
35
+
2. Scroll down the list to check if **OpenSSH Client** is listed. Otherwise,
36
+
click the plus sign next to **Add a feature**, select **OpenSSH Client**,
37
+
and click **Install**.
38
+
{:style="max-width: 400px !important;"}
39
+
</details>
40
+
41
+
-**Putty**[^3]: a widespread SSH client for Windows users, can be used as an
42
+
alternative to OpenSSH.
15
43
16
44
## Generate SSH Keys
17
45
18
-
As introduced previously, SSH keys are necessary to connect to the CLI using the credentials for the account under consideration.
46
+
As introduced previously, SSH keys are necessary to connect to the CLI using the
47
+
credentials for the account under consideration. You can create a RSA key of
48
+
size 4096 bits with the following command:
19
49
20
-
External tutorials are available on how to generate such keys for each of the Putty [^4] and OpenSSH [^5] clients.
where `-C` flag refers to comment, which could be any identifier. You will be
54
+
prompted to specify a file to save the key. Press Enter to accept the default
55
+
location. When prompted, enter a secure passphrase for your key. This step is
56
+
optional but recommended for added security. After keys are generated, there
57
+
will be two files `id_rsa` and `id_rsa.pub`. Please upload the public key file
58
+
`id_rsa.pub` as described below.
59
+
60
+
Please refer to the external tutorials on the advanced usage of OpenSSH [^4] and
61
+
Putty [^5] clients.
21
62
22
63
## Upload SSH Key
23
64
24
-
After generating the keys, they need to be uploaded to our platform and associated with the user's account. This effectively establishes a **secure link** between the external SSH client and the corresponding Exabyte account.
65
+
After generating the keys, the public key need to be uploaded to our platform
66
+
and associated with the user's account. This effectively establishes a
67
+
**secure link** between the external SSH client and the corresponding Mat3ra
68
+
account.
69
+
70
+
We explain how to upload the SSH keys to our platform in a
71
+
[separate section](../accounts/ui/preferences/ssh.md) of the documentation.
25
72
26
-
We explain how to upload the SSH keys to our platform in a [separate section](../accounts/ui/preferences/ssh.md) of the documentation.
27
-
28
73
!!!warning "Privacy of SSH keys"
29
-
SSH keys are **private** and are meant to be used to identify exclusively the user with our platform. Any other user logged in with such private keys would automatically have access to the account's data and allocation, and because of this they should not be shared with anyone else.
74
+
SSH keys are **private** and are meant to be used to identify exclusively
75
+
the user with our platform. Any other user logged in with such private keys
76
+
would automatically have access to the account's data and allocation, and
77
+
because of this they should not be shared with anyone else.
30
78
31
-
## Connect to Server
79
+
## Connecting to Mat3ra Server
32
80
33
-
Once the secure SSH link is established via the SSH keys, the remote Exabyte server can be accessed as follows (the user should replace the text inside braces below with the corresponding names/paths).
81
+
Once the secure SSH link is established via the SSH keys, the remote Mat3ra
82
+
server can be accessed as follows (the user should replace the text inside
83
+
braces below with the corresponding names/paths).
34
84
35
85
!!!info "Name of remote server"
36
-
Our Exabyte server for accepting remote connections is referred to under the alias of **"bohr"**, and is accessible via the corresponding address `login.mat3ra.com`.
86
+
Our Mat3ra server for accepting remote connections is referred to under the
87
+
alias of **"bohr"**, and is accessible via the corresponding address
88
+
`login.mat3ra.com`.
37
89
38
-
### OpenSSH for Unix
90
+
### SSH using OpenSSH
39
91
40
-
1. The user should first change the permissions on the private key to be accessible to him/her only.
92
+
1. The user should first change the permissions on the private key to be
93
+
accessible to him/her only.
41
94
42
95
```
43
96
chmod 400 {path/to/your/private_key}
@@ -46,46 +99,57 @@ Once the secure SSH link is established via the SSH keys, the remote Exabyte ser
46
99
2. At the command prompt, the user should then enter the following command.
Instructions on how to operate Putty to connect to our remote server can be found in Ref. [^6]. The name of the server to be used in this case is the same as before, namely `login.mat3ra.com`.
55
-
106
+
107
+
Instructions on how to operate Putty to connect to our remote server can be
108
+
found in Ref. [^6]. The name of the server to be used in this case is the same
109
+
as before, namely `login.mat3ra.com`.
110
+
56
111
### Enter the CLI
57
112
58
-
Following successful SSH connection, the user is presented with the [CLI of our platform](../cli/overview.md).
113
+
Following successful SSH connection, the user is presented with the
114
+
[CLI of our platform](../cli/overview.md).
59
115
60
-
Some useful instructions are already contained in the CLI **splash welcome screen** greeting the user at the moment of login. A copy of this welcome screen is reproduced below.
116
+
Some useful instructions are already contained in the CLI
117
+
**splash welcome screen** greeting the user at the moment of login. A copy of
The user can also transfer files back and forth from his/her local hard drives to the folders on the remote Exabyte server. For this purpose, we recommend the **SCP file transfer protocol** [^7], which is also based on SSH.
67
-
124
+
The user can also transfer files back and forth from his/her local hard drives
125
+
to the folders on the remote Exabyte server. For this purpose, we recommend the
126
+
**SCP file transfer protocol** [^7], which is also based on SSH. Detailed
127
+
instructions on how to transfer files using `scp` is available
128
+
[in a separate page](actions/transfer-files-scp.md).
129
+
68
130
### Windows Instructions
69
131
70
-
On Windows, we recommend the **WinSCP** graphical user interface program [^8]. A tutorial demonstrating how to operate it can be retrieved in Ref. [^9].
132
+
Once OpenSSH client is enabled on [Windows](#ssh-client),
133
+
[scp](#transfer-files-with-scp) command should be available via Windows
134
+
**PowerShell** and **Command Prompt** terminals.
71
135
72
-
When using WinSCP, one would need to load the private key through its interface before connecting. Explanations on how to do so can be found in Ref. [^10].
73
-
74
-
### Unix Instructions
136
+
Alternatively, you may use **WinSCP** graphical user interface program [^8]. A
137
+
tutorial demonstrating how to operate it can be retrieved in Ref. [^9].
75
138
76
-
The instructions for Unix-based operating systems can be found [in a separate page](actions/transfer-files-scp.md).
139
+
When using WinSCP, one would need to load the private key through its interface
140
+
before connecting. Explanations on how to do so can be found in Ref. [^10].
Copy file name to clipboardExpand all lines: mkdocs.yml
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ extra_javascript:
30
30
copyright: <a target="_blank" href="https://mat3ra.com">Exabyte Inc</a>. All rights reserved. | <a target="_blank" href="https://platform.mat3ra.com">Back to platform</a>
0 commit comments