1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-28 19:06:12 +01:00
unleash.unleash/website/docs/reference/project-collaboration-mode.md

65 lines
3.7 KiB
Markdown
Raw Normal View History

---
title: Project Collaboration Mode
---
2024-08-23 17:17:57 +02:00
:::note Availability
2024-08-23 17:17:57 +02:00
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.22+`
:::
2024-08-23 17:17:57 +02:00
# Overview
2024-08-23 17:17:57 +02:00
Project collaboration modes allow you to manage project visibility and interaction levels, ensuring better control and collaboration within your organization.
2024-08-23 17:17:57 +02:00
The collaboration mode of a [project](projects.md) defines who within your Unleash instance can access the project. This setting also determines who can submit [change requests](change-requests.md)a feature that provides controlled and secure updates for feature flags.
2024-08-23 17:17:57 +02:00
Unleash supports three collaboration modes: **open**, **protected**, and **private**. A user's [predefined root and project roles](rbac.md#predefined-roles), as well as their [custom root roles](rbac.md#custom-root-roles), determine what projects they can access.
2024-08-23 17:17:57 +02:00
## Open collaboration mode
2024-08-23 17:17:57 +02:00
All users of your Unleash instance can view the project and submit change requests. This is the default collaboration mode.
2024-08-23 17:17:57 +02:00
## Protected collaboration mode
2024-08-23 17:17:57 +02:00
All users of your Unleash instance can view the project but only project Members and Admins can submit change requests.
2024-08-23 17:17:57 +02:00
## Private collaboration mode
2024-08-23 17:17:57 +02:00
Only project Members, Admins, Editors, and users with [custom root roles](rbac.md#custom-root-roles) can view the project. Viewers, who are not project Members, can't see the project in the project list. Only project Members and Admins can submit change requests.
2024-08-23 17:17:57 +02:00
| | View project | Submit change requests |
|-----------|-------------------------------------------------------------------------------------------------|----------------------------|
| Open | All users | All users |
| Protected | All users | Project Members and Admins |
| Private | Project Members, Admins, Editors, and users with [custom root roles](rbac.md#custom-root-roles) | Project Members and Admins |
2024-08-23 17:17:57 +02:00
# Set project collaboration mode
2024-08-23 17:17:57 +02:00
To [create a new project](projects.md#create-a-project) with a specific collaboration mode, do the following:
1. In the Unleash Admin UI, go to **Projects** > **New project**.
2. Enter **Project name**.
3. Click **Open** to choose your collaboration mode.
4. Click **Create project**.
2024-08-23 17:17:57 +02:00
## Modify project collaboration mode
2024-08-23 17:17:57 +02:00
To modify the collaboration mode of an existing project, do the following:
1. In the Unleash Admin UI, go to **Projects** and select the project you want to modify.
2. Go to **Project settings > Enterprise settings** and use the **Project collaboration mode** list to update your collaboration mode.
3. Click **Save changes**.
2024-08-23 17:17:57 +02:00
### Change collaboration mode to protected
2024-08-23 17:17:57 +02:00
When you change the collaboration mode of an existing project to protected, all users who do not have sufficient permissions lose the ability to create new change requests. Existing change requests remain in place. Users with insufficient permissions can still cancel their change requests but can no longer update them.
2024-08-23 17:17:57 +02:00
### Change collaboration mode to private
When you change the collaboration mode of an existing project to private, all users who do not have [sufficient permissions](#private-collaboration-mode) lose access to the project, including their existing change requests.
## Migrate existing projects
When upgrading Unleash to version `4.22.0` or later, all migrated projects get the open collaboration mode by default. See [Modify project collaboration mode](#modify-project-collaboration-mode) for instructions on changing the collaboration mode of an existing project.