gitlab-org--gitlab-foss/doc/public_access/public_access.md

94 lines
3.6 KiB
Markdown
Raw Normal View History

---
type: reference
---
2014-04-24 18:48:22 -04:00
# Public access
2014-04-24 18:48:22 -04:00
GitLab allows [Owners](../user/permissions.md) to set a projects' visibility as **public**, **internal**
or **private**. These visibility levels affect who can see the project in the
public access directory (`/public` under your GitLab instance), like at [https://gitlab.com/public]().
## Visibility of projects
### Public projects
2014-04-24 18:48:22 -04:00
Public projects can be cloned **without any** authentication.
2014-04-24 18:48:22 -04:00
They will be listed in the public access directory (`/public`) for all users.
2014-04-24 18:48:22 -04:00
**Any logged in user** will have [Guest permissions](../user/permissions.md)
on the repository.
### Internal projects
2014-04-24 18:48:22 -04:00
Internal projects can be cloned by any logged in user.
2014-04-24 18:48:22 -04:00
They will also be listed in the public access directory (`/public`), but only for logged
in users.
2014-04-24 18:48:22 -04:00
Any logged in user will have [Guest permissions](../user/permissions.md)
2016-06-25 23:43:10 -04:00
on the repository.
NOTE: **Note:**
From July 2019, the `Internal` visibility setting is disabled for new projects, groups,
and snippets on GitLab.com. Existing projects, groups, and snippets using the `Internal`
visibility setting keep this setting. You can read more about the change in the
[relevant issue](https://gitlab.com/gitlab-org/gitlab-ee/issues/12388).
2018-07-09 06:48:18 -04:00
### Private projects
Private projects can only be cloned and viewed by project members (except for guests).
They will appear in the public access directory (`/public`) for project members only.
2018-07-09 06:48:18 -04:00
### How to change project visibility
2014-04-24 18:48:22 -04:00
1. Go to your project's **Settings**
1. Change "Visibility Level" to either Public, Internal or Private
2014-04-24 18:48:22 -04:00
2016-03-22 06:36:43 -04:00
## Visibility of groups
2019-06-12 01:47:06 -04:00
NOTE: **Note:**
[Starting with](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3323) GitLab 8.6,
the group visibility has changed and can be configured the same way as projects.
In previous versions, a group's page was always visible to all users.
2016-03-22 06:36:43 -04:00
Like with projects, the visibility of a group can be set to dictate whether
anonymous users, all signed in users, or only explicit group members can view
it. The restriction for visibility levels on the application setting level also
applies to groups, so if that's set to internal, the explore page will be empty
for anonymous users. The group page now has a visibility level icon.
2014-04-24 18:48:22 -04:00
## Visibility of users
The public page of a user, located at `/username`, is always visible whether
you are logged in or not.
When visiting the public page of a user, you can only see the projects which
you are privileged to.
If the public level is restricted, user profiles are only visible to logged in users.
2014-04-24 18:48:22 -04:00
## Restricting the use of public or internal projects
In the Admin area under **Settings** (`/admin/application_settings`), you can
restrict the use of visibility levels for users when they create a project or a
snippet:
![Restrict visibility levels](img/restrict_visibility_levels.png)
This is useful to prevent people exposing their repositories to public
by accident. The restricted visibility settings do not apply to admin users.
<!-- ## Troubleshooting
Include any troubleshooting steps that you can foresee. If you know beforehand what issues
one might have when setting this up, or when something is changed, or on upgrading, it's
important to describe those, too. Think of things that may go wrong and include them here.
This is important to minimize requests for support, and to avoid doc comments with
questions that you know someone might ask.
Each scenario can be a third-level heading, e.g. `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place
but commented out to help encourage others to add to it in the future. -->