Changes between Version 13 and Version 14 of cypress/FileTransfer

Timestamp:

06/29/20 21:47:56 (4 years ago)

Author:

cbaribault

Comment:

Added subtopic for generating rclone.conf file in the user's Cypress session.

cypress/FileTransfer

@@ -25 +25 @@
 In order to use rclone on Cypress, you must first create the config file ''~/.config/rclone/rclone.conf'' on your Cypress account, which you can do most easily by first creating a reusable copy of it on your local machine and then copying the resulting local file to your Cypress account via the following.
 
-==== Configuring rclone on Cypress ====
+==== 1st of 2 Options: Generating Your rclone.conf File In Your Cypress Session ====
+1. Login to Cypress from your local machine with X11 forwarding. (See [[cypress/SshUsage#TunnelingXWindowsSessionviaSSH|X11 Forwarding]].)
+2. In your Cypress session enter the following commands.
+{{{
+module load rclone
+rclone config
+}}}
+3. At the prompt '''...No remotes found - make a new one...''', enter {{{n}}} for '''New remote'''.
+4. At the prompt '''name>''', choose a meaningful name, e.g, {{{TU-Box}}}, to be used for future connection to your Tulane Box account from your Cypress command line session.
+5. At the prompt '''Type of storage to configure...''', enter {{{6}}} for '''Box'''.
+6. At the prompt '''...Box App Client Id...''', respond by pressing {{{Enter}}} for the default.
+7. At the prompt '''...Box App Client Secret...''', respond by pressing {{{Enter}}} for the default.
+8. At the prompt '''Edit advanced config? (y/n)nnn''', enter {{{n}}} for '''No'''.
+9. At the prompt '''Remote config - Use auto config?...''', enter {{{y}}} for '''Yes'''.
+10. Observe the message ending in '''Waiting for code ...''', and wait for a separate browser window to open on your local machine with a Box web page. Depending on your network latency, you may experience a delay of 1 minute or more.
+   In the Box web page, click on the link '''Use Single Sign On (SSO)'''.
+11. In the next Box web page, enter your full Tulane email address and click on '''Authorize'''.
+12. This will take you to the Tulane login web page, wherein you can complete your Tulane login information and click on '''Sign in'''.
+13. This final web page should show the message '''Success! - All done. Please go back to rclone''', at which point you can close the browser window and return to your Cypress session command line window.
+14. Back in the command line window, observe the new message '''Got code''' followed by your new token information ending with a prompt to which you can respond {{{y}}} for '''Yes this is OK'''.
+15. The resulting response shows the list '''Current remotes:''', including your new Box remote, e.g., '''TU-Box''' followed by a prompt to which you can respond {{{q}}} for '''Quit config'''.
+16. Observe the newly created config file '''~/.config/rclone/rclone.conf'''
+{{{
+[cbaribault@cypress1 ~]$ ls -l ~/.config/rclone/
+total 8
+-rw------- 1 cbaribault hpcstaff 233 Jun 29 20:00 rclone.conf
+[cbaribault@cypress1 ~]$ 
+}}}
+   at which point you're ready to run rclone on Cypress. (See '''Running rclone on Cypress''' below.)
+
+
+==== 2nd of 2 Options: Generating Your rclone.conf File Using Your Local Machine ====
 1. Download, install, and configure rclone on your local machine by following the instructions for Windows, Mac, or Linux as appropriate starting from the [https://rclone.org/install/ rclone installation site.]
-  a. During the above configuration, you will be prompted for a ''name'' for the Box remote system, e.g. ''!BoxRemote''.
+  a. During the above configuration, you will be prompted for a name for the Box remote system, e.g. '''TU-Box'''.
   b. Make note of your response for the name of the Box remote system for future reference to be used in your invocations of the rclone command.
-2. Once you've configured rclone on your local machine, locate the resulting file rclone.conf on your local machine.
-  a. On Mac and Linux, e.g., look for the file ~/.config/rclone/rclone.conf
-  b. On Windows 8 (or under) , e.g., look for the file %userprofile%\.config\rclone\rclone.conf
-3. Create as needed the directory ~/.config/rclone on your Cypress account.
-4. Copy the resulting local file rclone.conf to your Cypress directory ~/.config/rclone. See [[cypress/FileTransfer|File Transfer]].
-5. For security purposes, be sure to confirm that only you have ''exclusive'' read/write privileges to the resulting file ~/.config/rclone/rclone.conf on Cypress. See the ''ls'' and ''chmod'' commands under [[cypress/BasicLinuxComands|Linux Commands]]
+2. Once you've configured rclone on your local machine, locate the resulting file '''rclone.conf''' on your local machine.
+  a. On Mac and Linux, e.g., look for the file '''~/.config/rclone/rclone.conf'''
+  b. On Windows 8 (or under) , e.g., look for the file '''%userprofile%\.config\rclone\rclone.conf'''
+3. Create as needed the directory '''~/.config/rclone''' on your Cypress account.
+4. Copy the resulting file '''rclone.conf''' from your local machine to your Cypress directory '''~/.config/rclone'''. See [[cypress/FileTransfer|File Transfer]].
+5. For security purposes, be sure to confirm that only you have ''exclusive'' read/write privileges to the resulting file '''~/.config/rclone/rclone.conf''' on Cypress. See the ''ls'' and ''chmod'' commands under [[cypress/BasicLinuxComands|Linux Commands]]
 
-Once you have created the config file ''~/.config/rclone/rclone.conf'' on Cypress, you can run rclone via the following.
+Once you have created the config file '''~/.config/rclone/rclone.conf''' on Cypress, you can run rclone via the following.
 
 ==== Running rclone on Cypress ====
-1. The following command will list the contents of a top-level folder in your Box account with configured Box remote name !BoxRemote.
+1. To list the entire contents in your Box account with configured Box remote name '''TU-Box'''...
 {{{
-rclone ls BoxRemote:<top-level-folder>
+rclone ls TU-Box:
 }}}
-2. The following command will copy the contents of a top-level folder in your Box account with configured Box remote name !BoxRemote to your current Cypress working directory.
+2. To list the contents of a top-level folder in your Box account with configured Box remote name '''TU-Box'''...
 {{{
-rclone copy BoxRemote:<top-level-folder> .
+rclone ls TU-Box:<top-level-folder>
 }}}
-3. The following command will copy the file test.txt in your current Cypress working directory to a top-level folder in your Box account with configured Box remote name !BoxRemote.
+3. To copy the contents of a top-level folder in your Box account with configured Box remote name '''TU-Box''' to your current Cypress working directory...
 {{{
-rclone copy test.txt BoxRemote:<top-level-folder>
+rclone copy TU-Box:<top-level-folder> .
 }}}
-4. The following command will simply list the available subcommands under rclone.
+4. To copy the file test.txt in your current Cypress working directory to a top-level folder in your Box account with configured Box remote name '''TU-Box'''.
+{{{
+rclone copy test.txt TU-Box:<top-level-folder>
+}}}
+5. To simply list the available subcommands under rclone.
 {{{
 rclone --help