diff options
Diffstat (limited to 'doc/public_access/public_access.md')
| -rw-r--r-- | doc/public_access/public_access.md | 53 |
1 files changed, 31 insertions, 22 deletions
diff --git a/doc/public_access/public_access.md b/doc/public_access/public_access.md index 8601551e3bd..b1637181855 100644 --- a/doc/public_access/public_access.md +++ b/doc/public_access/public_access.md @@ -1,13 +1,12 @@ -# Public access - -GitLab allows [Owners](../user/permissions.md) to change a projects' visibility in order to be accessed -**publicly** or **internally**. +--- +type: reference +--- -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). +# Public access -Internal projects will only be available to authenticated users. +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 @@ -15,26 +14,26 @@ Internal projects will only be available to authenticated users. Public projects can be cloned **without any** authentication. -They will also be listed on the public access directory (`/public`). +They will be listed in the public access directory (`/public`) for all users. -**Any logged in user** will have [Guest](../user/permissions.md) -permissions on the repository. +**Any logged in user** will have [Guest permissions](../user/permissions.md) +on the repository. ### Internal projects Internal projects can be cloned by any logged in user. -They will also be listed on the public access directory (`/public`) for logged +They will also be listed in the public access directory (`/public`), but only for logged in users. -Any logged in user will have [Guest](../user/permissions.md) permissions +Any logged in user will have [Guest permissions](../user/permissions.md) on the repository. ### 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`). +Private projects can only be cloned and viewed by project members. + +They will appear in the public access directory (`/public`) for project members only. ### How to change project visibility @@ -43,10 +42,10 @@ they will only appear to project members on the public access directory ## 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. +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. 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 @@ -54,8 +53,6 @@ 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 - ## Visibility of users The public page of a user, located at `/username`, is always visible whether @@ -76,3 +73,15 @@ snippet: 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. --> |