-[What is the minimum setup before I start using GitLab?](#minimum-setup)
-[How do I get help?](#help)
-[How to generate and upload GitLab ssh-key?](#generate-ssh-key)
-[Why do I get "422 Error" when sign-in?](#422-error)
-[What is a GitLab project?](#GitLab-project)
-[What is the username space?](#username-space)
-[How many personal GitLab projects I can create?](#project-limit)
-[What is the default project visibility?](#project-visibility)
-[What is a GitLab group?](#GitLab-group)
-[Why my search turnout nothing?](#serach-scope)
-[Can I safeguard secrets in a private repo?](#no-secrets)
-[What are GitLab usage limits?](#usage-limits)
-[Is GitLab intergated with Stanford workgroup?](#workgroup)
-[Can I use GitLab for PHI data?](#no-phi)
## <a name="minimum-setup" ></a> What is the minimum setup before I start using GitLab?
Your gitlab user account will be automatically provisioned when the first time you login to Gitlab and
most of your user profile settings will be populated from Stanford directory, such as your account id (sunetid), name, email. You should not change these. If you get a "422 Error" after login to gitlab, see [Why do I get "422 Error?" when sign-in?](#422-error)
You can click **Profile Settings** button on the left panel to change default appearance for your GitLab web interface. You definitely want to look into the "SSH Keys" tab. In this tab, click the "Add SSH Key" button to add SSH keys so you can communicate with GitLab through git command.
## <a name="generate-ssh-key"></a> How to generate and upload GitLab ssh-key?
See [ GitLab and SSH keys ](https://docs.gitlab.com/ee/ssh/README.html#doc-nav)
## <a name="help" ></a> How do I get help?
For general usage questions, Use [Gitlab's help](https://gitlab.med.stanford.edu/help) documetation. For backend server gitlab.med.stanford.edu related
questions, please submit a [HelpSU](https://helpsu.stanford.edu/?pcat=itarch) ticket.
You can also join *git* slack channel on [SoM IRT Slack channel #med-svc-gitlab](https://som-irt.slack.com/messages/C1THB6X1C).
## <a name="422-error" ></a> Why do I get "422 Error" when sign-in?
If you get this error the first time your sign-in, most likely, your email contact information in [StanfordYou](https://stanfordyou.stanford.edu/main/SYApp?action=change_email)
is either private or doesn't exist. It can be caused by sponsorship changes. The email must be in format of \<your sunetid\>.stanford.edu.
gitlab.med.stanford.edu service requires your email address to log you in, and the email must be in stanford.edu domain and fully sponsored.
You should be able to go to stanfordyou.stanford.edu and add your email address -
click on 'Maintain your directory and AlertSU emergency contact information', then click 'change...'
next to 'SU Contact Info'. You need at least Stanford visibility for your email address.
## <a name="GitLab-project"></a> What is a GitLab project?
A GitLab project is all things about a project: a git repository, wiki, issues, documentations, etc.
## <a name="username-space"></a> What is the username space?
When you create a new project in GitLab, the default namespace for the project is the personal namespace associated with your GitLab userid. The git repositories created in your personal namespace looks like this:
## <a name="project-limit"></a> How many personal GitLab projects I can create?
The default personal project limit is 50.
## <a name="project-visibility"></a> What is the default project visibility?
Project visibility level in GitLab can be either private, internal or public. The default is **private**. As a project owner, you can change your project visibility by using your projetct's "Settings" function.
## <a name="GitLab-group"></a> What is a GitLab group?
Gitlab group allows you group projects together into one namespace (directory), so you can give other users permission to all projects in one place. You are allowed to create groups or transfer personal projects to a group that you own. Here is more information about [GitLab groups](http://doc.GitLab.com/ee/workflow/groups.html#GitLab-groups).
## <a name="search-scope"></a>Why my search turnout nothing?
Gitlab search scopes for CE version are limited to projects, issues, merge request. *Code* search is not supported. See [Search through GitLab](https://docs.gitlab.com/ce/user/search/)
## <a name="no-secrets"></a>Can I safeguard secrets in private repo?
Private repos will limit the visibility to it's members but it **IS NOT** a place to keep your secrets.
All git repo contents are stored **UNENCRYPTED** on the storage backend and accessiable by whoever has the access privileges to the backend.
Clone a repo will also distribute all secrets it contains and it is impossible to control the usage of the secrets after they are cloned.
**WARNING:** Do not store any secrets or config files that may contain secrets to a GitLab project regardless of its visibility.
You should use a secret/key management system for all secrets, e.g. [SoM Vault](https://vault.med.stanford.edu), [LastPass](https://lastpass.com), etc.
If you do want to use GitLab repo for secrets:
* Use [git-crypt](https://github.com/AGWA/git-crypt) to protect the secrets.
* You are on your own.
## <a name="usage-limits"></a>What are GitLab usage limits?
* Gitlab is NOT for PHI data
* Personal projects limit: 30
* Group projects limit: unlimited
* Maximum attachment size: 10MB
**WARNING:** Please don't use GitLab to store large binary data file, e.g. compiled code, images, and vedios, etc.. Use a cloud storage bucket, i.e. S3, Box, or GCS.
## <a name="workgroup"></a>Is GitLab intergated with Stanford's workgroup?
No. You can freely assemble your project team from members in different groups.
## <a name="no-phi"></a>Can I use GitLab for PHI data?
**NO,** you can not.
**WARNING** Do not store PHI data in any GitLab projects!
