debian-mirror-gitlab/doc/public_access/public_access.md

60 lines
1.9 KiB
Markdown
Raw Normal View History

2014-09-02 18:07:02 +05:30
# Public access
2015-12-23 02:04:40 +05:30
GitLab allows you to change your projects' visibility in order be accessed
**publicly** or **internally**.
2014-09-02 18:07:02 +05:30
2015-12-23 02:04:40 +05:30
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-09-02 18:07:02 +05:30
Internal projects will only be available to authenticated users.
2015-12-23 02:04:40 +05:30
## Visibility of projects
### Public projects
2014-09-02 18:07:02 +05:30
Public projects can be cloned **without any** authentication.
2015-12-23 02:04:40 +05:30
They will also be listed on the public access directory (`/public`).
2014-09-02 18:07:02 +05:30
2015-12-23 02:04:40 +05:30
**Any logged in user** will have [Guest](../permissions/permissions)
permissions on the repository.
2014-09-02 18:07:02 +05:30
2015-12-23 02:04:40 +05:30
### Internal projects
2014-09-02 18:07:02 +05:30
Internal projects can be cloned by any logged in user.
2015-12-23 02:04:40 +05:30
They will also be listed on the public access directory (`/public`) for logged
in users.
2014-09-02 18:07:02 +05:30
2015-12-23 02:04:40 +05:30
Any logged in user will have [Guest](../permissions/permissions) permissions on
the repository.
2014-09-02 18:07:02 +05:30
2015-12-23 02:04:40 +05:30
### How to change project visibility
2014-09-02 18:07:02 +05:30
2015-12-23 02:04:40 +05:30
1. Go to your project's **Settings**
1. Change "Visibility Level" to either Public, Internal or Private
2014-09-02 18:07:02 +05:30
## Visibility of users
2015-12-23 02:04:40 +05:30
The public page of a user, located at `/u/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.
2014-09-02 18:07:02 +05:30
2015-12-23 02:04:40 +05:30
## Visibility of groups
2014-09-02 18:07:02 +05:30
2015-12-23 02:04:40 +05:30
The public page of a group, located at `/groups/groupname`, is always visible
to everyone.
2014-09-02 18:07:02 +05:30
2015-12-23 02:04:40 +05:30
Logged out users will be able to see the description and the avatar of the
group as well as all public projects belonging to that group.
2014-09-02 18:07:02 +05:30
## Restricting the use of public or internal projects
2015-12-23 02:04:40 +05:30
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. This is useful to prevent people exposing their repositories to public
by accident. The restricted visibility settings do not apply to admin users.