Skip to content

Commit a508396

Browse files
SebastianPrehnSebastianPrehn
committed
Add Sign-up guide for SIF in relation to #11 
1 parent 3ec7bc0 commit a508396

File tree

3 files changed

+126
-1
lines changed

3 files changed

+126
-1
lines changed

‎docs/index.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,13 @@ ERDA/SIF: User Guides
2222
sections/erda/networkdrive/index
2323
sections/erda/seafile/index
2424
sections/erda/archiving/index
25+
26+
.. toctree::
27+
:maxdepth: 2
28+
:hidden:
29+
:caption: SIF User Guides
30+
31+
sections/sif/signup/index
2532

2633
.. danger::
2734
This documentation is WIP! We are currently focused on updating our ERDA-related resources.

‎docs/sections/erda/signup/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Sign up as an ERDA user
33
=======================
44

55
.. Note::
6-
This page is designed to help you get started with using `ERDA <https://erda.ku.dk/>`_. For SIF, WIP.
6+
This page is designed to help you get started with using `ERDA <https://erda.ku.dk/>`_. For SIF, check out :ref:`sif-signup-start`.
77

88
You can sign up to ERDA either as a UCPH employee/student (:ref:`erda-signup-ucph`) or as an external collaborataion partner (:ref:`erda-signup-external`), and you must sign up before you can access ERDA.
99
In addition, to further protect your account, we recommend that you check our section on :ref:`erda-signup-twofactor`.

‎docs/sections/sif/signup/index.rst

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
.. _sif-signup-start:
2+
Sign up as a SIF user
3+
=====================
4+
5+
.. Note::
6+
This page is designed to help you get started with using `SIF <https://sif.ku.dk/>`_. For ERDA, check out :ref:`erda-signup-start`.
7+
8+
You can sign up to SIF either as a UCPH employee/student (:ref:`sif-signup-ucph`) or as an external collaborataion partner (:ref:`sif-signup-external`), and you must sign up before you can access SIF.
9+
In addition, to further protect your account, it is compulsory to use two-factor authentication. You can check our section on :ref:`sif-signup-twofactor` for instructions on how to get it working.
10+
11+
.. _sif-signup-ucph:
12+
Sign up with a UCPH account
13+
===========================
14+
15+
Go to `SIF <https://sif.ku.dk/>`_ and click "Sign up".
16+
17+
In the pop-up window under "UCPH OpenID", enter:
18+
19+
- Your UCPH username (consists of three letters and three digits)
20+
21+
- Your personal UCPH password, which you also use, e.g. for KUnet
22+
23+
- Then click "Yes (allow)".
24+
25+
You are now registered as a SIF user.
26+
27+
.. _sif-signup-external:
28+
Sign up as an external collaboration partner
29+
============================================
30+
31+
Go to `SIF <https://sif.ku.dk/>`_ and click on the *External Users* tab, before clicking "Sign up".
32+
33+
You will be required to complete the form with your details:
34+
35+
- Full name: *Enter your full name*
36+
37+
- Email address: *Your work email (no third-party email services such as hotmail, gmail or yahoo)*
38+
39+
- Organisation: *The name of your workplace/company*
40+
41+
- Country: *Select your country in the drop-down menu*
42+
43+
- Password: *Create a sufficiently difficult password for your access. It must consist of at least eight characters and must contain a combination of lowercase and uppercase letters, digits and special characters (at least three of the four types mentioned). In “Verify password”, you repeat the password*
44+
45+
- Optional comment..: *Refer to your contact who is employed at the University of Copenhagen (name + email) and indicate any relevant project, course or collaboration.*
46+
47+
- I accept..: *Read the “terms and conditions” and tick the box*
48+
49+
Your request to sign up as a SIF user will now be sent to the SCIENCE HPC Center support team, who will obtain consent from the UCPH employee regarding the collaboration.
50+
51+
When the SCIENCE HPC Center administrators have accepted your request, you will receive an email.
52+
53+
To log in, click the link in the email and log onto the service with your email address and your service-specific password, before clicking "yes".
54+
55+
.. _sif-signup-twofactor:
56+
Two-factor Authentication
57+
=========================
58+
59+
.. note::
60+
To increase security, we have made it compulsory to use two-factor authentication for SIF access.
61+
62+
With two-factor authentication, you can add an extra verification step to the login process which authenticates you.
63+
In addition to asking about something you know (in this case your username and password), an account protected by two-factor authentication will also request a token from an app you have either on your phone, tablet, or desktop.
64+
65+
This guide contains all necessary knowledge for SIF.
66+
67+
68+
Setup
69+
-----
70+
71+
When you sign up for SIF, you must complete a one-time wizard to configure the compulsory two-factor authentication.
72+
Click ‘Okay, let’s go!’
73+
A wizard will now appear in SIF which you must carefully follow, either via its text in the wizard or by following along here.
74+
75+
Download App
76+
------------
77+
78+
You need to install a TOTP Authenticator client on either a phone or tablet, like `Google Authenticator <https://en.wikipedia.org/wiki/Google_Authenticator>`_, `FreeOTP <https://freeotp.github.io/>`_, `Yubico Authenticator <https://www.yubico.com/products/yubico-authenticator/#h-download-yubico-authenticator>`_, `Bitwarden <https://bitwarden.com/download/>`_ or `NetIQ Advanced Authentication <https://www.microfocus.com/en-us/cyberres/identity-access-management/advanced-authentication>`_. Find any of these where you normally download apps, and click "I've got it installed!".
79+
80+
.. note::
81+
If you only have a private mobile phone/tablet and you do not want to use it and are an UCPH employee, you may request a small device that you can use instead. Contact [email protected] for further information.
82+
83+
84+
Import personal two-factor code
85+
-------------------------------
86+
87+
Import your personal two-factor code with "Scan your Personal QR code" or type your personal key code.
88+
89+
.. image:: /images/authenticator/authenticator-import.png
90+
91+
92+
**Example with Scan your personal QR code:**
93+
94+
After clicking the button, a QR code pops up in either ERDA or SIF.
95+
96+
Open your downloaded app and find the option to scan a QR code. The screenshot below is from the *Google Authenticator* app.
97+
98+
.. image:: /images/authenticator/authenticator-scanqrcode.png
99+
100+
Now scan the QR code you have just opened in the wizard. Point your device's camera at the QR code (The app may ask for permission to use your camera. Allow this). Now the app scans the QR code and you may click "Done importing" in the Wizard.
101+
102+
Your application should now have a profile which generates a six-digit token, which changes every 30 seconds.
103+
104+
105+
Verify that it works
106+
--------------------
107+
108+
After downloading and importing your personal two-factor code, you can verify that it works properly by clicking the *Verify* button. A pop-up window automatically appears, and you must enter the token which shows up in your app. Please note that the token changes after 30 seconds, and will not work after that. Click the **Verify** button in the pop-up and it will confirm whether your two-factor is set up correct.
109+
110+
.. image:: /images/authenticator/authenticator-verify.png
111+
112+
113+
Enable two-factor Authentication
114+
--------------------------------
115+
116+
Click *Start Using UCPH SIF*.
117+
118+
Your SIF account is now protected with two-factor authentication, and you can safely login.

0 commit comments

Comments
 (0)