Commit 36c9fbfc authored by Adam Caprez's avatar Adam Caprez
Browse files

Merge branch 'globus-notify' into 'master'

Add info on disabling Globus emails.

See merge request !275
parents 3ef255db af411d49
...@@ -20,7 +20,7 @@ to their Globus account. To do so, follow these steps: ...@@ -20,7 +20,7 @@ to their Globus account. To do so, follow these steps:
2. Load the Globus CLI module: 2. Load the Globus CLI module:
{{< highlight bash >}}module load globus-cli {{< /highlight >}} {{< highlight bash >}}module load globus-cli {{< /highlight >}}
3. Use the command \`globus login\` to start the authorization 3. Use the command `globus login` to start the authorization
procedure. A web address will be displayed on screen. Copy and paste procedure. A web address will be displayed on screen. Copy and paste
this URL into your browser. this URL into your browser.
{{< figure src="/images/21071052.png" >}} {{< figure src="/images/21071052.png" >}}
...@@ -40,7 +40,7 @@ to their Globus account. To do so, follow these steps: ...@@ -40,7 +40,7 @@ to their Globus account. To do so, follow these steps:
{{< highlight bash >}}globus whoami{{< /highlight >}} {{< highlight bash >}}globus whoami{{< /highlight >}}
If you have logged in, you will see your email address displayed. If If you have logged in, you will see your email address displayed. If
not, the message "No login information available." will be not, the message _No login information available_ will be
displayed. displayed.
8. To terminate your Globus connection: 8. To terminate your Globus connection:
...@@ -66,7 +66,7 @@ activate an endpoint, use the command `globus endpoint activate --web`: ...@@ -66,7 +66,7 @@ activate an endpoint, use the command `globus endpoint activate --web`:
Copy the given URL and paste it into the address bar of your web Copy the given URL and paste it into the address bar of your web
browser. If you are not already logged into the Globus website, you will browser. If you are not already logged into the Globus website, you will
be prompted to do so. Once you are logged in, you need to click the be prompted to do so. Once you are logged in, you need to click the
\`Activate Now\` button to activate the endpoint. `Activate Now` button to activate the endpoint.
{{< figure src="/images/21073503.png" >}} {{< figure src="/images/21073503.png" >}}
Once an endpoint is activated, it will remain activate for 7 days. You Once an endpoint is activated, it will remain activate for 7 days. You
...@@ -76,32 +76,32 @@ can now transfer and manipulate files on the remote endpoint. ...@@ -76,32 +76,32 @@ can now transfer and manipulate files on the remote endpoint.
To make it easier to use, we recommend saving the UUID number as a bash To make it easier to use, we recommend saving the UUID number as a bash
variable to make the commands easier to use. For example, we will variable to make the commands easier to use. For example, we will
continue to use the above endpoint (Crane) by assigning its UUID code continue to use the above endpoint (Crane) by assigning its UUID code
to the variable \`crane\` as follows: to the variable `crane` as follows:
{{< figure src="/images/21073499.png" >}} {{< figure src="/images/21073499.png" >}}
This command must be repeated upon each new login or terminal session This command must be repeated upon each new login or terminal session
unless you save these in your environmental variables. If you do not unless you save these in your environmental variables. If you do not
wish to do this step, you can proceed by placing the correct UUID in wish to do this step, you can proceed by placing the correct UUID in
place of whenever you see \`$crane\`. place of whenever you see `$crane`.
{{% /notice %}} {{% /notice %}}
--- ---
### Endpoint Manipulation ### Endpoint Manipulation
Globus CLI supports the commands \`mkdir\`, \`rename\`, and \`ls\`. All Globus CLI supports the commands `mkdir`, `rename`, and `ls`. All
globus commands follow the format \`globus &lt;command&gt; globus commands follow the format `globus <command>
&lt;endpoint&gt;:&lt;file\_path&gt;\`. We can list the files on the <endpoint>:<file_path>`. We can list the files on the
remote endpoint with the command \`globus ls\`. To list the files in the remote endpoint with the command `globus ls`. To list the files in the
home directory on the remote endpoint, we would use the following home directory on the remote endpoint, we would use the following
command: command:
{{< figure src="/images/21073500.png" >}} {{< figure src="/images/21073500.png" >}}
To make a directory on the remote endpoint, we would use the \`globus To make a directory on the remote endpoint, we would use the `globus
mkdir\` command. For example, to make a folder in the users work mkdir` command. For example, to make a folder in the users work
directory on Crane, we would use the following command: directory on Crane, we would use the following command:
{{< figure src="/images/21073501.png" >}} {{< figure src="/images/21073501.png" >}}
To rename files on the remote endpoint, we can use the \`globus rename\` To rename files on the remote endpoint, we can use the `globus rename`
command. To rename the test file we just created above, we would use the command. To rename the test file we just created above, we would use the
command: command:
{{< figure src="/images/21073502.png" >}} {{< figure src="/images/21073502.png" >}}
...@@ -113,12 +113,12 @@ All transfers must take place between Globus endpoints. Even if you are ...@@ -113,12 +113,12 @@ All transfers must take place between Globus endpoints. Even if you are
transferring from an endpoint that you are already connected to, that transferring from an endpoint that you are already connected to, that
endpoint must be activated in Globus. Here, we are transferring between endpoint must be activated in Globus. Here, we are transferring between
Crane and Rhino. We have activated the Crane endpoint and saved its Crane and Rhino. We have activated the Crane endpoint and saved its
UUID to the variable $crane as we did for $crane above. UUID to the variable `$tusker` as we did for `$crane` above.
To transfer files, we use the command \`globus transfer\`. The format of To transfer files, we use the command `globus transfer`. The format of
this command is \`globus transfer &lt;endpoint1&gt;:&lt;file\_path&gt; this command is `globus transfer <endpoint1>:<file_path>
&lt;endpoint2&gt;:&lt;file\_path&gt;\`. For example, here we are <endpoint2>:<file_path>`. For example, here we are
transferring the file \`testfile.txt\` from the home directory on Crane transferring the file `testfile.txt` from the home directory on Crane
to the home directory on Crane: to the home directory on Crane:
{{< figure src="/images/21073505.png" >}} {{< figure src="/images/21073505.png" >}}
...@@ -128,12 +128,21 @@ using the given Task ID: ...@@ -128,12 +128,21 @@ using the given Task ID:
To transfer entire directories, simply specify a directory in the file To transfer entire directories, simply specify a directory in the file
path as opposed to an individual file. Below, we are transferring the path as opposed to an individual file. Below, we are transferring the
\`output\` directory from the home directory on Crane to the home `output` directory from the home directory on Crane to the home
directory on Crane: directory on Crane:
{{< figure src="/images/21073507.png" >}} {{< figure src="/images/21073507.png" >}}
For additional details and information on other features of the Globus For additional details and information on other features of the Globus
CLI, visit [Command Line Interface (CLI) Examples](https://docs.globus.org/cli/examples/) in the Globus documentation. CLI, visit [Command Line Interface (CLI) Examples](https://docs.globus.org/cli/examples/) in the Globus documentation.
### Disabling email notifications
By default, Globus will send an email notification for every successful transfer.
For large numbers of transfers, this may become overwhelming. Use the CLI, these
notifications can be disabled entirely, or only sent for specific conditions (i.e. failed
transfers only). To disable all notifications, run
{{< highlight bash >}}globus transfer --notify off{{< /highlight >}}
For details on additional notify options, see the [transfer command documentation](https://docs.globus.org/cli/reference/transfer/#options).
--- ---
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment