0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-12-01 19:17:12 -05:00
forgejo-docs/docs/user/repo-permissions.md

143 lines
6.2 KiB
Markdown
Raw Normal View History

2023-03-07 04:43:24 -05:00
---
2023-03-07 04:48:34 -05:00
title: 'Repository Permissions'
license: 'CC-BY-SA-4.0'
origin_url: 'https://codeberg.org/Codeberg/Documentation/src/commit/5d457efc069b52d512632fea024917e0848346cd/content/collaborating/repo-permissions.md'
2023-03-07 04:43:24 -05:00
---
2023-03-07 04:48:34 -05:00
When you invite collaborators to join your repository or when you create teams for your organization, you have to decide what each collaborator/team is allowed to do.
You can assign teams different levels of permission for each unit (e.g. issues, PR's, wiki).
2023-03-07 04:43:24 -05:00
## Profile and Visibility
Visibility of your repositories is in general inherited from your profile. So other user can only see your repositories, if your profile is _public_.
If you want to limit visibility access to your repositories you can set your **user visibility** in the user privacy settings to **Limited**. Even if your repository is public, non-contributors will get a 404-error if they try to access your repository.
![screenshot showing the updated README](../_images/user/repo-permissions/user-settings-privacy-limited.webp)
2023-03-07 04:43:24 -05:00
## Collaborators
There are four permission levels: Read, Write, Administrator and Owner.
The owner is the person who created the repository.
The table below gives an overview of what collaborators are allowed to do when granted each of these permission levels:
<table class="table">
<thead>
<tr>
<th scope="col"> Task </th>
<th scope="col"> Read </th>
<th scope="col"> Write</th>
<th scope="col"> Admin </th>
<th scope="col"> Owner </th>
2023-03-07 04:43:24 -05:00
</thead>
<tbody>
<tr>
<td scope="row"> View, clone and pull repository </td>
2023-03-07 04:48:34 -05:00
<td> <span style="color: green"></span> </td>
<td> <span style="color: green"></span> </td>
<td> <span style="color: green"></span> </td>
<td> <span style="color: green"></span> </td>
2023-03-07 04:43:24 -05:00
</tr>
<tr>
<td scope="row"> Contribute pull requests </td>
2023-03-07 04:48:34 -05:00
<td> <span style="color: green"></span> </td>
<td> <span style="color: green"></span> </td>
<td> <span style="color: green"></span> </td>
<td> <span style="color: green"></span> </td>
2023-03-07 04:43:24 -05:00
</tr>
<tr>
<td scope="row"> Push to/update contributed pull requests </td>
2023-03-07 04:48:34 -05:00
<td> <span style="color: green"></span> </td>
<td> <span style="color: green"></span> </td>
<td> <span style="color: green"></span> </td>
<td> <span style="color: green"></span> </td>
2023-03-07 04:43:24 -05:00
</tr>
<tr>
<td scope="row"> Push directly to repository </td>
<td> <span style="color: red"></span> </td>
2023-03-07 04:48:34 -05:00
<td> <span style="color: green"></span> </td>
<td> <span style="color: green"></span> </td>
<td> <span style="color: green"></span> </td>
2023-03-07 04:43:24 -05:00
</tr>
<tr>
<td scope="row"> Merge pull requests </td>
<td> <span style="color: red"></span> </td>
2023-03-07 04:48:34 -05:00
<td> <span style="color: green"></span> </td>
<td> <span style="color: green"></span> </td>
<td> <span style="color: green"></span> </td>
2023-03-07 04:43:24 -05:00
</tr>
<tr>
<td scope="row"> Moderate/delete issues and comments </td>
<td> <span style="color: red"></span> </td>
2023-03-07 04:48:34 -05:00
<td> <span style="color: green"></span> </td>
<td> <span style="color: green"></span> </td>
<td> <span style="color: green"></span> </td>
2023-03-07 04:43:24 -05:00
</tr>
<tr>
<td scope="row"> Force-push/rewrite history (if enabled) </td>
<td> <span style="color: red"></span> </td>
2023-03-07 04:48:34 -05:00
<td> <span style="color: green"></span> </td>
<td> <span style="color: green"></span> </td>
<td> <span style="color: green"></span> </td>
2023-03-07 04:43:24 -05:00
</tr>
<tr>
<td scope="row"> Add/remove collaborators to repository </td>
<td> <span style="color: red"></span> </td>
<td> <span style="color: red"></span> </td>
2023-03-07 04:48:34 -05:00
<td> <span style="color: green"></span> </td>
<td> <span style="color: green"></span> </td>
2023-03-07 04:43:24 -05:00
</tr>
<tr>
<td scope="row"> Configure branch settings (protect/unprotect, enable force-push) </td>
<td> <span style="color: red"></span> </td>
<td> <span style="color: red"></span> </td>
2023-03-07 04:48:34 -05:00
<td> <span style="color: green"></span> </td>
<td> <span style="color: green"></span> </td>
</tr>
2023-03-07 04:43:24 -05:00
<tr>
<td scope="row"> Configure repository settings (enable wiki, issues, PRs, releases, update profile) </td>
<td> <span style="color: red"></span> </td>
<td> <span style="color: red"></span> </td>
2023-03-07 04:48:34 -05:00
<td> <span style="color: green"></span> </td>
<td> <span style="color: green"></span> </td>
2023-03-07 04:43:24 -05:00
</tr>
<tr>
<td scope="row"> Configure repository settings in the danger zone (transfer ownership, delete wiki data / repository, archive repository) </td>
<td> <span style="color: red"></span> </td>
<td> <span style="color: red"></span> </td>
<td> <span style="color: red"></span> </td>
2023-03-07 04:48:34 -05:00
<td> <span style="color: green"></span> </td>
2023-03-07 04:43:24 -05:00
</tr>
</tbody>
</table>
## Teams
The permissions for teams are quite configurable. You can specify which repositories a team has access to; therefore, you can specify for each unit (Code Access, Issues, Releases) a different permission level.
Each unit is configured to have one of these 3 permission levels:
- No Access: Members cannot view or take any other action on this unit.
- Read: Members can view the unit, and do standard actions for that unit (See the Read column under [Collaborators](#collaborators)).
- Write: Members can view the unit, and execute write actions that unit (See the Write column under [Collaborators](#collaborators)).
When a team is configured to have administrator access, when this is specified, you cannot change units. The team will have admin permissions (See the Admin column under _Collaborators_).
2023-03-07 04:43:24 -05:00
Currently, there are six units that can be configured:
- Code: access source code, files, commits, and branches.
- Issues: organize bug reports, tasks, and milestones.
- Pull Requests: access pull requests, and code reviews.
- Releases: track the project versions and downloads.
- Wiki: access and write documentation.
- Projects: access and manage issues and pull requests in project boards.
There are also two units which can be toggled:
- External Wiki: access to external wiki.
- External Issues: access to the external issue tracker.
A team can be given the permission to create new repositories. When a member of such team creates a new repository, he/she will get administrator access to the repository.