Wiki source code of DevOps Portal for Users
Version 6.1 by DOaaS Operator on 2025/11/13 14:02
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
| |
1.1 | 1 | Welcome to the DevOps Portal. This guide will walk you through the initial steps to begin your first DevOps project seamlessly. |
| 2 | |||
| 3 | Below, you will find a series of actions required to get your project up and running: | ||
| 4 | |||
| 5 | {{toc/}} | ||
| 6 | |||
| 7 | |||
| |
3.1 | 8 | = Invitation and activation{{id name="Invitation and activation"/}} = |
| |
1.1 | 9 | |
| 10 | To begin using our software solution, you must first receive an invitation email from an administrator who has created your account. | ||
| 11 | |||
| 12 | This email will enable you to activate your account. | ||
| 13 | |||
| 14 | Please see the example below: | ||
| 15 | |||
| |
1.2 | 16 | (% class="confluence-embedded-file-wrapper confluence-embedded-manual-size" %)[[image:Screenshot 2024-11-14 145858.png||alt="Invitation email" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 17 | |
| 18 | Upon receiving an email containing an invitation link, you can activate your account by either clicking the link directly or copying and pasting it into a new browser window. | ||
| 19 | |||
| 20 | Once completed, you will be directed to a page on our platform confirming the successful activation of your account. | ||
| 21 | |||
| 22 | Please see the example below: | ||
| 23 | |||
| |
1.2 | 24 | (% class="confluence-embedded-file-wrapper confluence-embedded-manual-size" %)//[[image:Screenshot 2024-11-14 151028.png||alt="Activated account picture" data-xwiki-image-style-border="true" class="img-thumbnail"]]// |
| |
1.1 | 25 | |
| 26 | With your account now created and successfully activated, the next step is to set up your password. | ||
| 27 | |||
| 28 | Upon completing the activation process, the system will automatically send you an email containing a link to create your password. | ||
| 29 | |||
| 30 | Please see the example below: | ||
| 31 | |||
| |
1.2 | 32 | (% class="confluence-embedded-file-wrapper confluence-embedded-manual-size" %)//[[image:Screenshot 2024-11-14 153928.png||alt="Image of the password creation email" data-xwiki-image-style-border="true" class="img-thumbnail"]]// |
| |
1.1 | 33 | |
| 34 | Similar to the account activation process, you can create your password by either clicking the link provided in the email or by copying and pasting it into a new browser window. | ||
| 35 | |||
| 36 | Upon completion, you will be directed to a page on our platform prompting you to take further action. | ||
| 37 | |||
| 38 | Please click on the "**Click here to proceed**" link. | ||
| 39 | |||
| 40 | An example is provided below: | ||
| 41 | |||
| |
1.3 | 42 | (% class="confluence-embedded-file-wrapper confluence-embedded-manual-size" %)//[[image:Screenshot 2024-11-14 155143.png||alt="Page of password creation" data-xwiki-image-style-border="true" class="img-thumbnail"]]// |
| |
1.1 | 43 | |
| 44 | |||
| 45 | (% class="box infomessage" %) | ||
| 46 | ((( | ||
| 47 | == Optional Two-Factor Authentication(2FA) configuration == | ||
| 48 | |||
| 49 | At this stage of your account setup, it is possible that, based on your specific environment configuration, an additional level of authentication may be required. | ||
| 50 | |||
| 51 | If this is the case, the system will automatically prompt you to integrate this requirement into your setup. | ||
| 52 | |||
| 53 | To enable two-factor authentication, you will need a **smartphone **with an authenticator app installed such as **Google Authenticator** or **Microsoft Authenticator**. | ||
| 54 | |||
| 55 | After clicking "**Click here to proceed**" on the previous page, you will be directed to a screen resembling the one shown below: | ||
| 56 | |||
| |
1.2 | 57 | [[image:Screenshot 2024-11-19 091818.png||alt="Second Factor Authentication setup" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 58 | |
| 59 | After scanning the QR code, enter the code generated by your authenticator application and create a custom identifier to easily remember which smartphone or account can generate the correct one-time code. | ||
| 60 | |||
| 61 | If you are unable to scan the QR code, click on the "**Unable to scan**" link for alternative instructions to obtain the one-time code from your authenticator application. | ||
| 62 | |||
| 63 | Once you follow the instructions provided and click the "**Submit**" button or press **Enter **on your keyboard, you will be directed to the password update page | ||
| 64 | ))) | ||
| 65 | |||
| 66 | |||
| 67 | Whether or not you need to configure the second authentication factor, you will now be redirected to the password update page. | ||
| 68 | |||
| 69 | Here, you can select a new password that meets the required strength criteria. | ||
| 70 | |||
| 71 | Please enter your chosen password twice for confirmation. | ||
| 72 | |||
| 73 | After completing this step, click "**Submit**." | ||
| 74 | |||
| 75 | Below is an example screenshot for your reference: | ||
| 76 | |||
| |
1.2 | 77 | [[image:Screenshot 2024-11-14 155231.png||alt="Password creation" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 78 | |
| 79 | Once your password update is **successful**, you will be taken to a confirmation page indicating the update's success and providing a link to the application's login page. | ||
| 80 | |||
| 81 | Below is an example screenshot for your reference: | ||
| 82 | |||
| |
1.3 | 83 | [[image:Screenshot 2024-11-14 155401.png||alt="Page of password created" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 84 | |
| 85 | With this last step, your account **setup is complete**, and you can now use it to access the application. **Well done**. | ||
| 86 | |||
| 87 | |||
| |
4.1 | 88 | = Log in to DevOps Portal{{id name="Log in to DevOps Portal"/}} = |
| |
1.1 | 89 | |
| 90 | To access the application, begin by entering its URL into the address bar. | ||
| 91 | |||
| 92 | The application will then automatically direct you to the login screen. | ||
| 93 | |||
| 94 | Please refer to the example screenshot below: | ||
| 95 | |||
| |
1.3 | 96 | [[image:Screenshot 2024-11-14 155426.png||alt="Page of Log-in" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 97 | |
| 98 | You can now access the application by entering your email and password and clicking the "**Log in"** button, or by pressing the Enter key on your keyboard. | ||
| 99 | |||
| 100 | Below is an example of how to complete the fields: | ||
| 101 | |||
| |
1.3 | 102 | (% class="confluence-embedded-file-wrapper confluence-embedded-manual-size" %)[[image:Screenshot 2024-11-19 090916.png||alt="Login page filled" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 103 | |
| 104 | |||
| 105 | (% class="box infomessage" %) | ||
| 106 | ((( | ||
| 107 | == Optional Two-Factor Authentication(2FA) Request == | ||
| 108 | |||
| 109 | If you had to set up two-factor authentication (2FA) for each new login, you'll be asked to enter the one-time code generated by your authenticator application. | ||
| 110 | |||
| 111 | Once you've entered the code, click "**Submit**." | ||
| 112 | |||
| 113 | Below is an example screenshot: | ||
| 114 | |||
| |
1.3 | 115 | [[image:Screenshot 2024-11-19 091946.png||alt="Second Factor Authentication requested" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 116 | ))) |
| 117 | |||
| 118 | With this last step, you have successfully **logged in** and you can now use the application. **Well done**. | ||
| 119 | |||
| 120 | |||
| |
4.1 | 121 | = Forgotten Password{{id name="Forgotten Password"/}} = |
| |
1.1 | 122 | |
| 123 | To access the application, in case you have forgotten your password, start by loading the login screen in your browser. | ||
| 124 | |||
| 125 | On this page there is a link with the text "**Forgot Password?**" click on it to be redirected to the login recovery procedure. | ||
| 126 | |||
| 127 | Here is an example screenshot below: | ||
| 128 | |||
| |
1.3 | 129 | [[image:Screenshot 2024-11-14 155426.png||alt="Page of Log-in" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 130 | |
| 131 | Once you click on the "**Forgot Password?**" link, you will be shown a new page where you just need to enter your email address and then click "**Submit**" or press enter on your keyboard. | ||
| 132 | |||
| 133 | This action will send your email a link with which you can change your password. | ||
| 134 | |||
| 135 | Here is an example screenshot below: | ||
| 136 | |||
| |
1.3 | 137 | [[image:Screenshot 2024-11-19 092035.png||alt="Page of password reset" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 138 | |
| 139 | |||
| 140 | (% class="box infomessage" %) | ||
| 141 | ((( | ||
| 142 | == Optional Two-Factor Authentication(2FA) Request == | ||
| 143 | |||
| 144 | If you had to set up two-factor authentication (2FA) for each password change, you'll be asked to enter the one-time code generated by your authenticator application. | ||
| 145 | |||
| 146 | Once you've entered the code, click "**Submit**." | ||
| 147 | |||
| 148 | Below is an example screenshot: | ||
| 149 | |||
| |
1.3 | 150 | [[image:Screenshot 2024-11-19 091946.png||alt="Second Factor Authentication requested" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 151 | ))) |
| 152 | |||
| 153 | You will then have to wait for the **password reset email** to arrive in your **inbox**. | ||
| 154 | |||
| 155 | Of course, it's always a good idea to check the **Spam **section of your inbox or **repeat the steps** if the email doesn't seem to be arriving, before contacting the support. | ||
| 156 | |||
| 157 | Here is a sample screenshot of the email below: | ||
| 158 | |||
| |
1.3 | 159 | [[image:Screenshot 2024-11-19 092201.png||alt="Email of password reset" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 160 | |
| 161 | Once you click on the password reset link, your browser will open to a web page. On this webpage, you will be asked to choose a new password that meets the required security criteria. | ||
| 162 | |||
| 163 | Enter your chosen password twice to confirm. | ||
| 164 | |||
| 165 | After completing this step, click "**Submit**." | ||
| 166 | |||
| 167 | Here's a sample screenshot of the page below: | ||
| 168 | |||
| |
1.4 | 169 | [[image:Screenshot 2024-11-19 092226.png||alt="Page of password change" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 170 | |
| 171 | With this last step, you have successfully **reset your password**, and you can now use the application. **Well done**. | ||
| 172 | |||
| 173 | |||
| |
4.1 | 174 | = Change password{{id name="Change password"/}} = |
| |
1.1 | 175 | |
| 176 | If you wish to change your password, the first step is to log in to the portal using your credentials. | ||
| 177 | |||
| 178 | Once you are logged in, locate and click on the "**Account"** drop-down menu in the main menu. | ||
| 179 | |||
| 180 | Within the drop-down menu, you will find an option labeled "**Password**" click on this option to proceed with changing your password. | ||
| 181 | |||
| 182 | Below is an example screenshot: | ||
| 183 | |||
| |
1.4 | 184 | [[image:Screenshot 2024-11-19 144030.png||alt="Triggering Change Password" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 185 | |
| 186 | Once you click on the "**Password**" link, you will be shown a new page. | ||
| 187 | |||
| 188 | On this page, your email address is placed in square brackets. | ||
| 189 | |||
| 190 | You just have to press the "**Request e-mail for new password**" button to send you the email to change your password. | ||
| 191 | |||
| 192 | Here is an example screenshot below: | ||
| 193 | |||
| |
1.4 | 194 | [[image:Screenshot 2024-11-19 144045.png||alt="Password Reset image" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 195 | |
| 196 | You will then have to wait for the **password change email** to arrive in your **inbox**. | ||
| 197 | |||
| 198 | Of course, it's always a good idea to check the **Spam **section of your inbox or **repeat the steps** if the email doesn't seem to be arriving, before contacting the support. | ||
| 199 | |||
| 200 | Here is a sample screenshot of the email below: | ||
| 201 | |||
| |
1.4 | 202 | [[image:Screenshot 2024-11-19 092201.png||alt="Email of password reset" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 203 | |
| 204 | Once you click on the password change link, your browser will open to a web page. On this webpage, you will be asked to choose a new password that meets the required security criteria. | ||
| 205 | |||
| 206 | Enter your chosen password twice to confirm. | ||
| 207 | |||
| 208 | After completing this step, click "**Submit**." | ||
| 209 | |||
| 210 | Here's a sample screenshot of the page below: | ||
| 211 | |||
| |
1.4 | 212 | [[image:Screenshot 2024-11-19 092226.png||alt="Page of password reset" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 213 | |
| 214 | With this last step, you have successfully **changed your password**, and you can now use the application. **Well done**. | ||
| 215 | |||
| 216 | |||
| |
5.1 | 217 | = Select Languages - Sprachen auswählen{{id name="Select Languages"/}} = |
| |
1.1 | 218 | |
| 219 | The DevOps portal is set to **English **by default, which applies to all web pages and sent emails within the system. | ||
| 220 | |||
| 221 | However, there is an option available on each page we created to change the settings and switch to **German (Deutsch)**. | ||
| 222 | |||
| 223 | Here is a sample screenshot below: | ||
| 224 | |||
| |
1.4 | 225 | [[image:Screenshot 2024-11-21 152351.png||alt="change language" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 226 | |
| 227 | Within the DevOps portal, users have the option to change the language. | ||
| 228 | |||
| 229 | This can be done via the drop-down "**Language**" menu located in the top left corner. | ||
| 230 | |||
| 231 | Any changes made will be applied to the system's web and email pages. | ||
| 232 | |||
| |
1.4 | 233 | [[image:Screenshot 2024-11-21 152713.png||alt="change language in the portal" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 234 | |
| 235 | With this **last step**, you are now aware of all the possibilities for the selected language. **Well done**. | ||
| 236 | |||
| 237 | |||
| 238 | Wenn das DevOps-Portal auf **Deutsch **eingestellt ist, gilt dies für alle Websites und E-Mails, die innerhalb des Systems versendet werden. | ||
| 239 | |||
| 240 | Auf jeder Seite, die wir erstellt haben, steht jedoch eine Option zur Verfügung, um die Einstellungen zu ändern und auf **Englisch(English)** zu wechseln. | ||
| 241 | |||
| 242 | Hier ist ein Beispiel-Screenshot unten: | ||
| 243 | |||
| |
1.4 | 244 | [[image:Screenshot 2024-11-21 152426.png||alt="change language german" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 245 | |
| 246 | Innerhalb des DevOps-Portals haben Benutzer die Möglichkeit, die Sprache zu ändern. | ||
| 247 | |||
| 248 | Dies kann über das Dropdown-Menü "**Sprache**" in der oberen linken Ecke erfolgen. | ||
| 249 | |||
| 250 | Alle vorgenommenen Änderungen werden auf die Web- und E-Mail-Seiten des Systems angewendet. | ||
| 251 | |||
| |
1.4 | 252 | [[image:Screenshot 2024-11-21 154936.png||alt="change language in the portal german" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 253 | |
| 254 | Mit diesem **letzten Schritt** sind Sie sich nun über alle Möglichkeiten für die ausgewählte Sprache im Klaren. **Gut gemacht**. | ||
| 255 | |||
| 256 | |||
| 257 | = The First Access = | ||
| 258 | |||
| 259 | After completing the logging in for the first time, you might find yourself facing a **completely blank page**, as shown in the example screenshot provided below: | ||
| 260 | |||
| |
2.1 | 261 | [[image:Screenshot 2024-11-21 152652.png||alt="no projects" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 262 | |
| 263 | Please do not be **alarmed**. This situation typically indicates that you have not yet been assigned any projects, or there might be a configuration issue. | ||
| 264 | |||
| 265 | The application itself is **functioning correctly**. To address this matter, there are a few steps you can take. | ||
| 266 | |||
| 267 | If you have **contact **information for the **system administrator**, please reach out to them directly for assistance. | ||
| 268 | |||
| 269 | The administrator will be **able to assign** the necessary project or projects or rectify any configuration **problems**. | ||
| 270 | |||
| 271 | If you do not have direct contact with the administrator, you can easily identify them by navigating to the users page located in the main menu. | ||
| 272 | |||
| 273 | This will provide you with the information needed to reach out to the appropriate person **for support**. | ||
| 274 | |||
| 275 | Once everything has been configured correctly and any necessary project assignments have been made, the page **will no longer be empty**. | ||
| 276 | |||
| 277 | Instead, you will see **links to all the tools **and resources you have access to, enabling you to fully utilize the application. | ||
| 278 | |||
| 279 | Here is a sample screenshot below: | ||
| 280 | |||
| |
2.1 | 281 | [[image:Screenshot 2024-11-22 135917.png||alt="nomal login" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 282 | |
| 283 | With this last step, you have successfully **made your first access**. **Well done**. | ||
| 284 | |||
| 285 | |||
| 286 | = The Projects Page = | ||
| 287 | |||
| 288 | In the main menu, one of the most important pages you will encounter is the **Projects page**. | ||
| 289 | |||
| 290 | This page provides a comprehensive overview of all the projects that have been assigned to you, along with a detailed view of their various features and attributes. | ||
| 291 | |||
| 292 | Key informantion available on this page include **Project key**, **Type**, **Status**, and **Project Role**. | ||
| 293 | |||
| 294 | To help you better understand, we have provided an example screenshot below: | ||
| 295 | |||
| |
2.1 | 296 | [[image:Screenshot 2024-11-22 140014.png||alt="projects page" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 297 | |
| 298 | This page also allows you to **search **for projects that you have access to with the search bar under the **Projects **heading. | ||
| 299 | |||
| 300 | While with the **drop-down** menu on the left you can select a **portal user** to see if they have access to the projects you have access to. | ||
| 301 | |||
| 302 | It is important to note that the appearance of this screen may vary depending on your permission level. | ||
| 303 | |||
| 304 | If you have been granted a **higher level of permissions**, your view might look different from the example provided. | ||
| 305 | |||
| 306 | In such cases, you can simply **follow **this link: [[DevOps Portal for Admins>>doc:DevOps Portal for Admins.WebHome]] to access the relevant information. | ||
| 307 | |||
| 308 | For those who need more detailed information about the **individual tools**, we recommend referring to the **specialized pages** dedicated to it. | ||
| 309 | |||
| 310 | These pages offer **in-depth explanations** and **guidance **on how to effectively utilize each tool. | ||
| 311 | |||
| 312 | Here is a list of useful links that you may find helpful for further details: | ||
| 313 | |||
| 314 | * [[Jira>>doc:Jira.WebHome]] | ||
| 315 | * [[Confluence>>doc:Confluence.WebHome]] | ||
| 316 | * [[Bitbucket>>Bitbucket]] | ||
| 317 | * [[Jenkins>>doc:Jenkins.WebHome]] | ||
| 318 | * [[Sonarqube>>doc:SonarQube.WebHome]] | ||
| 319 | * [[Gitea>>doc:Gitea.WebHome]] | ||
| 320 | * [[Harbor>>doc:Harbor.WebHome]] | ||
| 321 | * [[Rancher 2>>doc:Rancher 2.WebHome]] | ||
| 322 | |||
| 323 | With this last step, you have successfully **analized your project page**. **Well done**. | ||
| 324 | |||
| 325 | |||
| 326 | = The Users Page = | ||
| 327 | |||
| 328 | In the main menu, another crucial page you will come across is the **Users **page. | ||
| 329 | |||
| 330 | This page is designed to provide you with a comprehensive overview of all the users who have been **created within the portal**. | ||
| 331 | |||
| 332 | Below, you will find an example screenshot: | ||
| 333 | |||
| |
2.1 | 334 | [[image:Screenshot 2024-11-22 140413.png||alt="User page" data-xwiki-image-style-border="true" class="img-thumbnail"]] |
| |
1.1 | 335 | |
| 336 | The is a **search bar** located under the Users heading enables you to quickly find the **user you are looking** for by entering relevant keywords. | ||
| 337 | |||
| 338 | Additionally, on the **left side** of the page, you will find a **drop-down **menu that allows you to filter the projects to which you have access. | ||
| 339 | |||
| 340 | This feature helps you to streamline your search and view only the users associated with specific projects. | ||
| 341 | |||
| 342 | You can sort the table in both **ascending **and **descending **order by **simply clicking on the headers** of the columns you wish to sort. | ||
| 343 | |||
| 344 | Moreover, the Users page is equipped with easily accessible **contact **information for the **administrators**. | ||
| 345 | |||
| 346 | The information is presented in a clear and straightforward manner, **minimizing **any potential confusion or **delays in communication**. | ||
| 347 | |||
| 348 | With this last step, you have successfully **analized your user page**. **Well done**. |