diff --git a/src/pages/en/tutorials/adding-users.mdx b/src/pages/en/tutorials/adding-users.mdx index bd1f32d7..9eadb543 100644 --- a/src/pages/en/tutorials/adding-users.mdx +++ b/src/pages/en/tutorials/adding-users.mdx @@ -1,36 +1,74 @@ --- -title: "Adding Users" -metaTitle: "Adding Users" -metaDescription: "Learn how to add users to your self-hosted OpenReplay instance" +title: "Users and Access" +metaTitle: "Adding users and setting up access" +metaDescription: "Learn how to add users and set up access in OpenReplay" --- -Once you've installed your self-hosted version of OpenReplay, you'll be able to sign-up **only one user** on that system. -Afterwards, the `openreplay./signup` link will not work, in fact, it will redirect to the log-in page. -If you need more users to access the system, you'll have to invite them into your team. +OpenReplay provides a flexible and secure system for managing users and their access. This guide outlines how to invite and manage users across different OpenReplay deployments, including FOSS, Cloud, and Enterprise setups. It also covers roles and permissions control, which is exclusive to Enterprise users. -## Inviting users to your team +## Invite Users -Notice that the "team" is already created when you sign-up, so there is no need to worry about that part. Instead, you'll only want to invite your colleagues using the following steps: +### Self-Hosted (FOSS and Enterprise) -1. Go to the settings section by clicking on the cog icon located on the top-right corner of your screen: +For self-hosted setups, only one user can sign up during the initial configuration. After the first user is created, the signup page at `openreplay./signup` will redirect to the login page. -![Click on the settings icon](./images/invite-users/click-config-cog.png) +To add additional users: -2. Once there, click on the "Teams" option from the menu located on the left side of the screen: +1. Navigate to **Preferences > Team** in the OpenReplay dashboard. +2. Click the **Add Team Member** button. +3. Fill in the user’s details: + - **Full Name** + - **Email Address** +4. (Optional) Select **Admin Privileges** to grant team and project management permissions. +5. Click **Invite**. -![Click on "Teams"](./images/invite-users/click-teams.png) +> **Note:** Ensure your SMTP server is configured to send email invitations. If not, you must manually copy and share the invitation link. Refer to the [SMTP Configuration Guide](https://docs.openreplay.com/configuration/configure-smtp) for setup details. -3. You should now be looking at your team, which consists of only you (if you haven't invited anyone yet). Now click on the "+" icon next to "Team 1". +### Cloud Users -![Click on the "+" icon](./images/invite-users/click-plus.png) +Cloud users (Serverless or Dedicated) can manage invitations through the dashboard. Invited users automatically receive email invitations when added. -4. Now start filling in the information requested, which is the full name of the user and their email address. You'll also be able to give them Admin proviledges if you want to, which would allow them to access project configurations and to invite other users into the team. +1. Navigate to **Preferences > Team** in the OpenReplay dashboard. +2. Click the **Add Team Member** button. +3. Provide the user’s details as above. +4. Assign roles and privileges if applicable. -![Add the user](./images/invite-users/add-user-warning.png) +
+ Add Spot to Chrome +
-**Note the SMTP warning** -If you haven't yet configure the SMTP server for OpenReplay, your users will not get a notification email with the sign-up link. So if you still need to configure it, check out how to do it with [this link](https://docs.openreplay.com/configuration/configure-smtp). +> **Cloud Users Access:** The user who first created the account has **Admin Privileges** and is assigned the role of **Owner**. All invitees are given the role **Member** by default if they are not granted with Admin Privileges, else they are given the **Admin** . -## Have questions? +## Remove Users -If you have any issues adding new users to your self-hosted installation, please contact us on our [Slack community](https://slack.openreplay.com/) and ask our devs directly! \ No newline at end of file +To remove a user: + +1. Navigate to **Preferences > Team** in the OpenReplay dashboard. +2. Locate the user in the team list. +3. Click the **Edit** icon next to their name. +4. Click the **Delete** icon. + +
+ Add Spot to Chrome +
+ +> **Note:** Admin Privileges are required to remove users. + +## Roles and permissions + +Roles and permissions allows administrators to define specific permissions for projects and features. This functionality is only available for **[Enterprise users](https://openreplay.com/enterprise.html)**. + +### Add a Role + +1. Navigate to **Preferences > Roles and Access** in the OpenReplay dashboard. +2. Click the **Add** button. +3. Define the role: + - **Title:** e.g., Developer. + - **Project Access:** Select the projects the role can access. + - **Feature Access:** Specify the features this role can access. +4. Save the role. + + +## Have Questions? + +If you encounter any issues, reach out to us through our [Slack Community](#) and get direct assistance from our developers. diff --git a/src/pages/en/tutorials/images/invite-users/add_user.gif b/src/pages/en/tutorials/images/invite-users/add_user.gif new file mode 100644 index 00000000..cde1cb02 Binary files /dev/null and b/src/pages/en/tutorials/images/invite-users/add_user.gif differ diff --git a/src/pages/en/tutorials/images/invite-users/remove_user.gif b/src/pages/en/tutorials/images/invite-users/remove_user.gif new file mode 100644 index 00000000..60b7e172 Binary files /dev/null and b/src/pages/en/tutorials/images/invite-users/remove_user.gif differ