Skip to content
Snippets Groups Projects
Commit dc469cb8 authored by Benguria Elguezabal, Gorka's avatar Benguria Elguezabal, Gorka
Browse files

adds enrollment guide

parent 28bfba2e
No related branches found
No related tags found
No related merge requests found
.media/image21.png

49.9 KiB

.media/image22.png

81.8 KiB

.media/image23.png

32.6 KiB

# enroll
# Enroll
The objective of this repo is to provide guidance on how to enroll in the EMERALD project, or any other project that uses git.code.tecnalia.com as a repository.
In order to enroll a project such as EMERALD, you need to follow the next steps:
## Getting started
* register in git.code.tecnalia.com with orein
* login to git.code.tecnalia.com
* request access to the project responsible
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
## Register in git.code.tecnalia.com with orein
First of all you have to create an account in git.code.tecnalia.com so that you can be added latter to a project. In order to create an account:
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
* Access to Orein
* Register account
* Activate 2fa
* Activate authenticator
* Copy recovery codes
* Confirm email
* Login
## Add your files
To log in go to the root url of the gitlab repository [htts://git.code.tecnalia.com/](https://git.code.tecnalia.com/) as an external user or click `Sign in` if you are in another page ( i.e. https://git.code.tecnalia.com/groups/emerald ).
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
![Anonym access](.media/image01.png)
```
cd existing_repo
git remote add origin https://git.code.tecnalia.com/emerald/public/enroll.git
git branch -M master
git push -uf origin master
```
In both ways you will reach the login page.
## Integrate with your tools
![Anonym login page](.media/image02.png)
- [ ] [Set up project integrations](https://git.code.tecnalia.com/emerald/public/enroll/-/settings/integrations)
There you have three options to log in:
* LDAP
* Standard
* Orein OpenID
## Collaborate with your team
As an external user you have to use the Orein OpenID option. Click on the Orein OpenID button and you will be redirected to the Orein login page.
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
![Orein login page](.media/image03.png)
## Test and Deploy
Orein login page offers different options.
1. Register an account on orein
2. Login with an active account on orein
3. Use an identity provider as
* github
* Google
* Microsoft
* Amazon
4. Use a [FIDO2](https://fidoalliance.org/fido2/)
5. Use a Tecnalia account
6. And reocover the orein account password if you have forgotten it.
Use the built-in continuous integration in GitLab.
External users can use the first four options. we will address the registering process in this guide. Click on the `Register (1)` button.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
![Register Page](.media/image04.png)
***
To register we require email and password with some complexity.
# Editing this README
![Password Complexity](.media/image05.png)
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
Immediately, you are going to be asked to configure the `2FA` two factor authentication. Which is mandatory for all users in git.code.tecnalia.com.
## Suggestions for a good README
![2FA](.media/image06.png)
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
Following the instructions you should configure your Authenticator app. In this case we show the process with the [Microsoft Authenticator](https://play.google.com/store/apps/details?id=com.azure.authenticator&hl=es&gl=US) app. But you can use any other app that supports the TOTP protocol such as [Google Authenticator](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2&hl=es&gl=US) or [Authy](https://play.google.com/store/apps/details?id=com.authy.authy&hl=es&gl=US).
## Name
Choose a self-explaining name for your project.
![MSAutheticator01](.media/image07.png)![MSAutheticator02](.media/image08.png)![MSAutheticator03](.media/image09.png)![MSAutheticator04](.media/image10.png)![MSAutheticator05](.media/image11.png)![MSAutheticator06](.media/image12.png)
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
That number should be used to confirm the 2FA configuration.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
![2FA comfirm code](.media/image13.png)
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
Once validated the 2FA you will be shown the recovery codes.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
![Recovery code](.media/image14.png)
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
**Important**: **Copy Authentication recovery codes** in a secure place. These are required in case you lost the authenticator. The can be also used to login in case you have forgotten the password and you need to reset it.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
![2FA Configured](.media/image15.png)
Comfirm email (Beware of spam)
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
![Comfirm email](.media/image16.png)
![Confirmation page](.media/image17.png)
![Spam](.media/image18.png)
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
## login to git.code.tecnalia.com
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
To login using orein you have to click on the Orein OpenID button and you will be redirected to the Orein login page. There you have to use the first (2) option. The number 2 in the image below.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
![Orein login page](.media/image03.png)
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
To login
## License
For open source projects, say how it is licensed.
![Orein login page with data](.media/image19.png)
![2FA request](.media/image20.png)
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
That will drive you to the welcome page or the group page where you have clicked the login button.
![Welcome page](.media/image21.png)
## Request access to the project responsible
There are two ways to request access to the project.
- Send an email to a project owner https://git.code.tecnalia.com/groups/emerald/-/group_members
- Once you are logged in you can request access. Clicking the request access button.
![Request Access](.media/image22.png)
## Trouble shooting
In case of sign-up or sign-in issues contact project owners https://git.code.tecnalia.com/groups/emerald/-/group_members at tecnalia.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment