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

79 lines
2.6 KiB
Markdown
Raw Normal View History

2014-05-27 08:12:15 -04:00
# Public access
GitLab allows you to change your projects' visibility in order be accessed
**publicly** or **internally**.
2014-04-24 18:48:22 -04:00
Projects with either of these visibility levels will be listed in the
public access directory (`/public` under your GitLab instance).
Here is the [GitLab.com example](https://gitlab.com/public).
2014-04-24 18:48:22 -04:00
Internal projects will only be available to authenticated users.
## 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 also be listed on the public access directory (`/public`).
2014-04-24 18:48:22 -04:00
**Any logged in user** will have [Guest](../user/permissions.md)
permissions 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 on the public access directory (`/public`) for logged
in users.
2014-04-24 18:48:22 -04:00
Any logged in user will have [Guest](../user/permissions.md) permissions
2016-06-25 23:43:10 -04:00
on the repository.
2018-07-09 06:48:18 -04:00
### Private projects
Private projects can only be cloned and viewed by project members, and
they will only appear to project members on the public access directory
(`https://gitlab.example.com/public`).
### 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
>**Note:**
[Starting with][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.
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.
[3323]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3323
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.