Deployed dd7d43c with MkDocs version: 1.5.3

EPCCed · Jan 15, 2024 · 0c7cec9 · 0c7cec9
1 parent efee44b
commit 0c7cec9
Show file tree

Hide file tree

Showing 76 changed files with 354 additions and 293 deletions.
diff --git a/404.html b/404.html
@@ -12,7 +12,7 @@
 
 
       <link rel="icon" href="/eidf-docs/images/favicon.ico">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.2">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.4">
 
 
 
@@ -2077,10 +2077,10 @@ <h1>404 - Not found</h1>
     </div>
 
 
-    <script id="__config" type="application/json">{"base": "/eidf-docs/", "features": ["tabs"], "search": "/eidf-docs/assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
+    <script id="__config" type="application/json">{"base": "/eidf-docs/", "features": ["tabs"], "search": "/eidf-docs/assets/javascripts/workers/search.c011b7c0.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="/eidf-docs/assets/javascripts/bundle.d7c377c4.min.js"></script>
+      <script src="/eidf-docs/assets/javascripts/bundle.7389ff0e.min.js"></script>
 
 
   </body>

diff --git a/access/index.html b/access/index.html
@@ -18,7 +18,7 @@
 
 
       <link rel="icon" href="../images/favicon.ico">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.2">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.4">
 
 
 
@@ -2236,10 +2236,10 @@ <h2 id="ssh-access-to-computing-services">SSH Access to Computing Services</h2>
     </div>
 
 
-    <script id="__config" type="application/json">{"base": "..", "features": ["tabs"], "search": "../assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
+    <script id="__config" type="application/json">{"base": "..", "features": ["tabs"], "search": "../assets/javascripts/workers/search.c011b7c0.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../assets/javascripts/bundle.d7c377c4.min.js"></script>
+      <script src="../assets/javascripts/bundle.7389ff0e.min.js"></script>
 
 
   </body>

diff --git a/access/project/index.html b/access/project/index.html
@@ -18,7 +18,7 @@
 
 
       <link rel="icon" href="../../images/favicon.ico">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.2">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.4">
 
 
 
@@ -2386,10 +2386,10 @@ <h3 id="approved-project">Approved Project</h3>
     </div>
 
 
-    <script id="__config" type="application/json">{"base": "../..", "features": ["tabs"], "search": "../../assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
+    <script id="__config" type="application/json">{"base": "../..", "features": ["tabs"], "search": "../../assets/javascripts/workers/search.c011b7c0.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../../assets/javascripts/bundle.d7c377c4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.7389ff0e.min.js"></script>
 
 
   </body>

diff --git a/access/ssh/index.html b/access/ssh/index.html
@@ -18,7 +18,7 @@
 
 
       <link rel="icon" href="../../images/favicon.ico">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.2">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.4">
 
 
 
@@ -740,10 +740,25 @@
 
 </li>
 
+      </ul>
+    </nav>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#enabling-mfa-via-the-portal" class="md-nav__link">
+    <span class="md-ellipsis">
+      Enabling MFA via the Portal
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="Enabling MFA via the Portal">
+      <ul class="md-nav__list">
+
           <li class="md-nav__item">
-  <a href="#using-the-ssh-key-to-access-eidf-windows-and-linux" class="md-nav__link">
+  <a href="#using-the-ssh-key-and-totp-code-to-access-eidf-windows-and-linux" class="md-nav__link">
     <span class="md-ellipsis">
-      Using the SSH-Key to access EIDF - Windows and Linux
+      Using the SSH-Key and TOTP Code to access EIDF - Windows and Linux
     </span>
   </a>
 
@@ -2264,10 +2279,25 @@
 
 </li>
 
+      </ul>
+    </nav>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#enabling-mfa-via-the-portal" class="md-nav__link">
+    <span class="md-ellipsis">
+      Enabling MFA via the Portal
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="Enabling MFA via the Portal">
+      <ul class="md-nav__list">
+
           <li class="md-nav__item">
-  <a href="#using-the-ssh-key-to-access-eidf-windows-and-linux" class="md-nav__link">
+  <a href="#using-the-ssh-key-and-totp-code-to-access-eidf-windows-and-linux" class="md-nav__link">
     <span class="md-ellipsis">
-      Using the SSH-Key to access EIDF - Windows and Linux
+      Using the SSH-Key and TOTP Code to access EIDF - Windows and Linux
     </span>
   </a>
 
@@ -2363,7 +2393,14 @@ <h1 id="ssh-access-to-virtual-machines-using-the-eidf-gateway-jump-host">SSH Acc
 }
 </style>
 
-<p>The EIDF-Gateway is an SSH gateway suitable for accessing EIDF Services via a console or terminal. As the gateway cannot be 'landed' on, a user can only pass through it and so the destination (the VM IP) has to be known for the service to work. Users connect to their VM through the jump host using their given accounts.</p>
+<p>The EIDF-Gateway is an SSH gateway suitable for accessing EIDF Services via a console or terminal. As the gateway cannot be 'landed' on, a user can only pass through it and so the destination (the VM IP) has to be known for the service to work. Users connect to their VM through the jump host using their given accounts.
+You will require three things to use the gateway:</p>
+<ol>
+<li>A user within a project allowed to access the gateway and a password set.</li>
+<li>An SSH-key linked to this account, used to authenticate against the gateway.</li>
+<li>Have MFA setup with your project account via SAFE.</li>
+</ol>
+<p>Steps to meet all of these requirements are explained below.</p>
 <h2 id="generating-and-adding-an-ssh-key">Generating and Adding an SSH Key</h2>
 <p>In order to make use of the EIDF-Gateway, your EIDF account needs an SSH-Key associated with it.
 If you added one while creating your EIDF account, you can skip this step.</p>
@@ -2396,17 +2433,39 @@ <h3 id="adding-the-new-ssh-key-to-your-account-via-the-portal">Adding the new SS
 <li>Select your username</li>
 <li>Select the plus button under  'Credentials'</li>
 <li>Select 'Choose File' to upload the PUBLIC (.pub) ssh key generated in the last step, or open the <ssh-key>.pub file you just created and copy its contents into the text box.</li>
-<li>Click 'Upload Credential' - it should look something like this:
-   <img alt="eidf-portal-ssh" class="border-img" src="../../images/access/eidf-portal-ssh.png" /></li>
+<li>Click 'Upload Credential' - it should look something like this:</li>
 </ol>
+<p><img alt="eidf-portal-ssh" class="border-img" src="../../images/access/eidf-portal-ssh.png" /></p>
 <h4 id="adding-a-new-ssh-key-via-safe">Adding a new SSH Key via SAFE</h4>
 <p>This should not be necessary for most users, so only follow this process if you have an issue or have been told to by the EPCC Helpdesk.
 If you need to add an SSH Key directly to SAFE, you can follow this <a href="https://epcced.github.io/safe-docs/safe-for-users/#how-to-add-an-ssh-public-key-to-your-account">guide.</a>
 However, select your '[username]@EIDF' login account, not 'Archer2' as specified in that guide.</p>
-<h3 id="using-the-ssh-key-to-access-eidf-windows-and-linux">Using the SSH-Key to access EIDF - Windows and Linux</h3>
+<h2 id="enabling-mfa-via-the-portal">Enabling MFA via the Portal</h2>
+<p>A multi-factor Time-Based One-Time Password is now required to access the SSH Gateway. <br></p>
+<p>To enable this for your EIDF account:</p>
 <ol>
-<li>From your local terminal, import the SSH Key you generated above: <code>$ ssh-add [sshkey]</code></li>
-<li>This should return "Identity added [Path to SSH Key]" if successful. You can then follow the steps below to access your VM.</li>
+<li>Login to the <a href="https://portal.eidf.ac.uk">portal.</a></li>
+<li>Select 'Projects' then 'Your Projects'</li>
+<li>Select the project containing the account you'd like to add MFA to.</li>
+<li>Under 'Your Accounts', select the account you would like to add MFA to.</li>
+<li>Select 'Set MFA Token'</li>
+<li>Within your chosen MFA application, scan the QR Code or enter the key and add the token.</li>
+<li>Enter the code displayed in the app into the 'Verification Code' box and select 'Set Token'</li>
+<li>You will be redirected to the User Account page and a green 'Added MFA Token' message will confirm the token has been added successfully.</li>
+</ol>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>TOTP is only required for the SSH Gateway, not to the VMs themselves, and not through the VDI.<br>
+An MFA token will have to be set for each account you'd like to use to access the EIDF SSH Gateway.</p>
+</div>
+<h3 id="using-the-ssh-key-and-totp-code-to-access-eidf-windows-and-linux">Using the SSH-Key and TOTP Code to access EIDF - Windows and Linux</h3>
+<ol>
+<li>
+<p>From your local terminal, import the SSH Key you generated above: <code>$ ssh-add [sshkey]</code></p>
+</li>
+<li>
+<p>This should return "Identity added [Path to SSH Key]" if successful. You can then follow the steps below to access your VM.</p>
+</li>
 </ol>
 <h2 id="accessing-from-macoslinux">Accessing From MacOS/Linux</h2>
 <div class="admonition warning">
@@ -2418,6 +2477,7 @@ <h2 id="accessing-from-macoslinux">Accessing From MacOS/Linux</h2>
 <div class="highlight"><pre><span></span><code>ssh<span class="w"> </span>-J<span class="w"> </span><span class="o">[</span>username<span class="o">]</span>@eidf-gateway.epcc.ed.ac.uk<span class="w"> </span><span class="o">[</span>username<span class="o">]</span>@<span class="o">[</span>vm_ip<span class="o">]</span>
 </code></pre></div>
 <p>The <code>-J</code> flag is use to specify that we will access the second specified host by jumping through the first specified host.</p>
+<p>You will be prompted for a 'TOTP' code upon successful public key authentication to the gateway. At the TOTP prompt, enter the code displayed in your MFA Application.</p>
 <h2 id="accessing-from-windows">Accessing from Windows</h2>
 <p>Windows will require the installation of OpenSSH-Server to use SSH. Putty or MobaXTerm can also be used but won’t be covered in this tutorial.</p>
 <h3 id="installing-and-using-openssh">Installing and using OpenSSH</h3>
@@ -2443,6 +2503,7 @@ <h3 id="accessing-eidf-via-a-terminal">Accessing EIDF via a Terminal</h3>
 </ol>
 <div class="highlight"><pre><span></span><code>ssh<span class="w"> </span>-J<span class="w"> </span><span class="o">[</span>username<span class="o">]</span>@eidf-gateway.epcc.ed.ac.uk<span class="w"> </span><span class="o">[</span>username<span class="o">]</span>@<span class="o">[</span>vm_ip<span class="o">]</span>
 </code></pre></div>
+<p>You will be prompted for a 'TOTP' code upon successful public key authentication to the gateway. At the TOTP prompt, enter the code displayed in your MFA Application.</p>
 <h2 id="first-password-setting-and-password-resets">First Password Setting and Password Resets</h2>
 <p>Before logging in for the first time you have to reset the password using the web form in the EIDF Portal following the instructions in <a href="../../services/virtualmachines/quickstart/#set-or-change-the-password-for-a-user-account">Set or change the password for a user account</a>.</p>
 
@@ -2491,10 +2552,10 @@ <h2 id="first-password-setting-and-password-resets">First Password Setting and P
     </div>
 
 
-    <script id="__config" type="application/json">{"base": "../..", "features": ["tabs"], "search": "../../assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
+    <script id="__config" type="application/json">{"base": "../..", "features": ["tabs"], "search": "../../assets/javascripts/workers/search.c011b7c0.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../../assets/javascripts/bundle.d7c377c4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.7389ff0e.min.js"></script>
 
 
   </body>

diff --git a/access/virtualmachines-vdi/index.html b/access/virtualmachines-vdi/index.html
@@ -18,7 +18,7 @@
 
 
       <link rel="icon" href="../../images/favicon.ico">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.2">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.4">
 
 
 
@@ -2500,10 +2500,10 @@ <h2 id="further-information">Further information</h2>
     </div>
 
 
-    <script id="__config" type="application/json">{"base": "../..", "features": ["tabs"], "search": "../../assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
+    <script id="__config" type="application/json">{"base": "../..", "features": ["tabs"], "search": "../../assets/javascripts/workers/search.c011b7c0.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../../assets/javascripts/bundle.d7c377c4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.7389ff0e.min.js"></script>
 
 
   </body>