Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 19 additions & 18 deletions docs/Admin-and-data/Account/Cloud/profile.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,37 @@
# Profile
# User Profile

This section lets you manage your personal profile settings, including your profile details, email addresses, and connected accounts.


## Accessing profile settings

![!Screenshot](../../Account/Cloud/access-profile.png)

!!! tip
You can also quickly access your profile by clicking your name and avatar at the bottom left corner of the screen on the Account page.
The **User Profile** page lets you manage your personal account settings and preferences, including your display name, email addresses, and connected accounts.

## Profile details

In **Profile details**, you’ll see your profile photo (or initials if no image is uploaded) along with your display name. You’ll also find a list of the email addresses linked to your account.
The **Profile details** section shows your current profile photo (or initials if no image has been uploaded) and your display name.

### Updating your profile

### Updating your Profile Settings
Click **Update profile** to open the edit panel where you can:

You can update your profile settings by clicking **Update profile** in the Profile section. This brings up a panel where you can change your profile photo, first name, and last name. To update your image, click the **Upload** button—make sure your file is a square (1:1 aspect ratio) and no larger than 10MB.

Below the image, you’ll find fields for your first and last name. Make any changes as needed, then click **Save** to apply them. If you change your mind, you can click **Cancel** to exit without saving.
- Upload a new profile photo (must be square, 1:1 aspect ratio, max 10 MB)
- Update your first and last name

Click **Save** to apply changes, or **Cancel** to exit without saving.

![!Screenshot](../../Account/Cloud/update.png)

### Updating your email address
## Email addresses

This section lists all email addresses linked to your account, with your primary address clearly labelled.

To add another email address to your account, click the **+ Add email address** button. A field will appear where you can type in the new email you'd like to associate with your profile.
### Adding an email address

After entering the address, click **Add**. You’ll be asked to verify the new email before it’s officially added to your account. This ensures that the email belongs to you and can be used for login, notifications, or as a backup. If you change your mind, just click **Cancel** to exit without adding it.
Click **+ Add email address**, enter the new address, then click **Add**. You will receive a verification email before the address is officially added to your account.

![!Screenshot](../../Account/Cloud/add-email.png)

## Connected accounts

The **Connected accounts** section shows any third-party accounts linked to your profile (e.g. Google). These can be used for single sign-on (SSO) when logging in to OpsPilot.

---

!!! question "Need more help?"
Contact support in the chat bubble and let us know how we can assist.
50 changes: 26 additions & 24 deletions docs/Admin-and-data/Account/Cloud/security.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,47 @@
# Security
# User Security

This dedicated Security page serves as your central hub for managing and enhancing the protection of your account. Here, you can actively control various aspects of your digital safety, including setting and updating your password, configuring secure passkeys for streamlined and robust authentication, and enabling two-step verification for an added layer of defense against unauthorized access. Additionally, you'll find a clear overview of your active devices, allowing you to monitor where your account is currently logged in. This comprehensive section empowers you to maintain strong control over your account's integrity and privacy.
The **User Security** page lets you manage the security settings for your account, including your password, passkeys, and two-step verification.

![!Screenshot](../../Account/Cloud/Security.png)

## Password

This section allows you to change your account password.
To set a new password:

### Changing your Password
1. Enter your new password in the **New password** field.
2. Re-enter it in the **Confirm password** field.
3. Check **Sign out of all other devices** to revoke access from any other active sessions.
4. Click **Save** to apply, or **Cancel** to discard.

To set a new password, you will find two fields: **New password** and **Confirm password**. Enter your desired new password into the "New password" field, and then re-enter the exact same password into the "Confirm password" field to ensure accuracy.
## Passkeys

Below these fields, you'll see an option to **Sign out of all other devices**. It is highly recommended to check this box. Doing so will automatically sign out any other devices that may still be logged in with your old password, enhancing your account's security.
Passkeys provide a more convenient and secure way to sign in without a password.

Once you have entered and confirmed your new password and made your selection for signing out of other devices, click **Save** to apply the changes. If you decide not to change your password or wish to discard your entries, simply click **Cancel** to return to the previous page without saving.
### Adding a passkey

## Passkeys
Click **+ Add a passkey**. You will be prompted to choose where to save it:

Passkeys provide a more convenient and secure way to sign in.


### Adding a Passkey

When you click **+ Add a passkey** from the Security page, a "Windows Security" pop-up window will appear, prompting you to "Choose where to save this passkey." This step allows you to select the method you prefer for storing your new passkey.
| Option | Description |
|---|---|
| **iPhone, iPad, or Android device** | Saves the passkey to your mobile device using Face ID, Touch ID, or screen lock |
| **Security key** | Saves the passkey to a physical FIDO-compliant hardware key (e.g. YubiKey) |

![!Screenshot](../../Account/Cloud/passkey.png)
You have the following options:

* **iPhone, iPad, or Android device:** Select this option if you wish to save your passkey to a mobile device. This typically involves using your phone's built-in security features (like Face ID, Touch ID, or screen lock) to authenticate and store the passkey securely. You might be prompted to scan a QR code or approve a notification on your mobile device.
* **Security key:** Choose this option if you have a physical security key (like a YubiKey or similar FIDO-compliant device) and want to use it to store your passkey. This method offers strong, hardware-based security.
Click **Next** to complete setup, or **Cancel** to abort.

Once you have selected your preferred method:
## Two-step verification

* Click **Next** to proceed with the passkey creation process based on your chosen storage option. You will then follow further instructions to complete the setup.
* Click **Cancel** to close the window and abort the passkey addition process without saving any new passkey.
Two-step verification adds a second layer of security to your login by requiring a time-sensitive code from an authenticator app (e.g. Google Authenticator, Microsoft Authenticator, or Authy).

## Two-step verification
### Setting up two-step verification

When you opt to add two-step verification, you'll be presented with the **+ two-step verification** prompt. This method enhances your account's security by requiring a second form of verification in addition to your password. To set this up, you'll need an authenticator app on your smartphone (such as Google Authenticator, Microsoft Authenticator, or Authy).
1. Click **+ Two-step verification**.
2. Scan the QR code displayed on screen using your authenticator app.
3. If you cannot scan the QR code, click **Can't scan QR code?** to enter the key manually.
4. Click **Continue** to complete setup, or **Cancel** to abort.

The page displays a unique QR code that you must scan using your chosen authenticator application. Scanning this QR code will securely link the app to your account, generating time-sensitive codes that you'll use for future logins. If you are unable to scan the QR code, click the **Can't scan QR code?** link for alternative setup instructions, typically involving a manual key entry.
---

Once the QR code is scanned and the app is linked, click **Continue** to finalize the setup, or **Cancel** to abort the process.
!!! question "Need more help?"
Contact support in the chat bubble and let us know how we can assist.
104 changes: 19 additions & 85 deletions docs/Admin-and-data/Account/Cloud/users.md
Original file line number Diff line number Diff line change
@@ -1,107 +1,41 @@
# Account & member management
# Organization Users

## Organizational settings
The **Organization Users** page lets you view and manage all members of your organization, assign roles, and invite new users.

### General

This section covers the basic organization-level settings accessible under the **General** tab in FusionReactor Cloud.

![!Screenshot](../../Account/Cloud/general.png)


#### Organization Profile

The Organization Profile section lets you view and update your organization's name and logo, which are shown to all members across the interface.

#### Leave organization

The **Leave organization** option lets any member (except the last admin) remove themselves from the org, which immediately revokes access to all org data and requires a new admin invitation to rejoin.

!!! note
If you're the last admin in the organization, you **cannot leave** — you must either promote another member to admin or delete the organization instead.



#### Delete organization

Only admins can delete the organization, which permanently removes all members, data, and settings — this action cannot be undone.


### Members

The **Members** tab in FusionReactor Cloud allows you to manage all users associated with your organization. You can view member details, assign roles, invite new members, and control access.
## Viewing members

![!Screenshot](../../Account/Cloud/members.png)

#### Viewing members

Each row in the Members list includes:

* **Name & Email** – Display name and primary email address.
* **Joined** – Date the user was added to the organization.
* **Role** – The current permission level assigned to the member.
* **Actions** – (⋯) menu to remove a member.

You can also:
Each row in the members list includes:

* Use the search bar to filter members by name or email.
* Navigate through multiple pages if your org has many users.
| Field | Description |
|---|---|
| **Name & Email** | Display name and primary email address |
| **Joined** | Date the user was added to the organization |
| **Role** | The current permission level assigned to the member |
| **Actions (...)** | Remove the member from the organization |

Use the search bar to filter members by name or email.

#### Inviting members
## Inviting members

Click the **Invite** button in the top-right to add new users:
Click **Invite** in the top right to add a new user:

1. Enter the email address of the invitee.
2. Assign a default role.
3. Click **Invite** to send the invitation.

!!! info
Users are notified by email when invited to an organization.

## Role management

#### Role management
Use the dropdown under Role to instantly change a member’s permission level.
Use the **Role** dropdown to instantly change a member's permission level.

!!! info "Learn more"
[Roles](/Admin-and-data/Account/Cloud/roles/)


### API Keys

The **API Keys** page allows you to manage access credentials used by services or agents to communicate with FusionReactor Cloud.

#### Viewing & managing keys

Each listed API key displays:

- **Name** – A user-defined label.
- **Description** – A short explanation of the key’s purpose.
- **Status toggle** – Temporarily enable or disable a key.
- **Copy icon** – Instantly copies the key to your clipboard (if visible).
- **Actions menu (⋯)** – Click to:
- **Edit** – Change the key’s name or description.
- **Remove** – Permanently delete the key.

!!! note
Deleting a key immediately revokes access for anything using it.



#### Creating a new key

Click **+ Generate** to create a key. You’ll enter:

- **Name** (required)
- **Description** (optional)

### Billing

The Billing section provides access to your organization's subscription details, invoices, and payment methods.

!!! info "Learn more"
[Billing](/Admin-and-data/Billing/Cloud/overview/)




---

!!! question "Need more help?"
Contact support in the chat bubble and let us know how we can assist.
2 changes: 1 addition & 1 deletion docs/Admin-and-data/EULA.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ You shall not: <br>
**Provided, however**, notwithstanding the foregoing, you are **strictly prohibited** from installing or using the Trial Version of the Software for any **commercial training purpose**.


You shall not use the Developer Version for any application deployment in a **live**, **stand-by production**, or **staging** environment in each case including, without limitation, any environment accessed by application end-users, including but not limited to:
You shall not use the Developer Version for any application deployment in a **live**, **stand-by production**, or **staging** environment - in each case including, without limitation, any environment accessed by application end-users, including but not limited to:

* servers,
* workstations,
Expand Down
Binary file added docs/Admin-and-data/Images/invoices.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 33 additions & 0 deletions docs/Admin-and-data/api-keys.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# API Keys

The **API Keys** page lets you manage access credentials used by services and agents to communicate with OpsPilot.

## Viewing & managing keys

Each listed API key displays:

| Field | Description |
|---|---|
| **Name** | A user-defined label for the key |
| **Description** | A short explanation of the key's purpose |
| **Status toggle** | Temporarily enable or disable the key |
| **Copy icon** | Copies the key value to your clipboard |
| **Actions (...)** | Edit the key's name or description, or permanently remove it |

!!! note
Deleting a key immediately revokes access for anything using it.

## Creating a new key

Click **+ Generate** to create a new API key:

1. Enter a **Name** (required).
2. Enter a **Description** (optional).
3. Click **Generate** to create the key.

Copy the key immediately after creation - it will not be shown again in full.

---

!!! question "Need more help?"
Contact support in the chat bubble and let us know how we can assist.
21 changes: 21 additions & 0 deletions docs/Admin-and-data/invoices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Invoices

The **Invoices** page lets you view and manage your invoices and upcoming payments.

![!Screenshot](Images/invoices.png)

Each invoice displays the following information:

| Field | Description |
|---|---|
| **Invoice ID** | A unique identifier for the invoice |
| **Status** | Payment status (e.g. paid, pending) |
| **Date** | The date the invoice was issued |
| **Amount** | The total amount charged |

Click the download icon on the right of any invoice to download it as a PDF.

---

!!! question "Need more help?"
Contact support in the chat bubble and let us know how we can assist.
25 changes: 25 additions & 0 deletions docs/Admin-and-data/organization-settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Organization Settings

The **Organization Settings** page lets you manage your organization's profile and general configuration in OpsPilot.

![!Screenshot](Account/Cloud/general.png)

## Organization Profile

The Organization Profile section lets you view and update your organization's name and logo, which are shown to all members across the interface.

## Leave organization

The **Leave organization** option lets any member (except the last admin) remove themselves from the organization. This immediately revokes access to all org data and requires a new admin invitation to rejoin.

!!! note
If you are the last admin in the organization, you **cannot leave** - you must either promote another member to admin or delete the organization instead.

## Delete organization

Only admins can delete the organization. This permanently removes all members, data, and settings and cannot be undone.

---

!!! question "Need more help?"
Contact support in the chat bubble and let us know how we can assist.
37 changes: 37 additions & 0 deletions docs/Admin-and-data/usage-and-details.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Usage & Details

The **Usage & Details** page gives you a real-time view of your cloud subscription status and current ingest usage against your plan limits.

## Cloud Subscription

The subscription card shows the key details of your current plan:

| Field | Description |
|---|---|
| **Plan** | Your current subscription tier (e.g. Trial, Starter, Pro AI, Advanced AI) |
| **Interval** | Whether your plan is billed monthly or annually |
| **Status** | Current subscription status (e.g. active, expired) |
| **Renews At** | The date your subscription next renews |
| **Bills At** | The date your next invoice will be generated |

## Ingest usage

The **Ingest** section shows your current consumption against your plan limits for the active billing period:

| Signal | Description |
|---|---|
| **Logs** | Volume of log data ingested (bytes / GB) |
| **Traces** | Volume of trace data ingested (bytes / GB) |
| **Metrics** | Number of active metric series |
| **Agents** | FusionReactor agent hours consumed |
| **OpsPilot** | OpsPilot AI tokens consumed |

A progress bar shows the percentage of your allowance used. If you exceed your plan limit, on-demand billing applies for the overage.

!!! info "Learn more"
[Billing overview](/Admin-and-data/Billing/Cloud/overview/) for a full breakdown of plan limits and on-demand rates.

---

!!! question "Need more help?"
Contact support in the chat bubble and let us know how we can assist.
2 changes: 1 addition & 1 deletion docs/Contribute/how-to-contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Contributing to our documentation is simpler than you might think. While you don

- Click the pencil icon to enter edit mode.
- Make your desired changes to the content.
- Don't worry about perfect formatting or grammar our team will help with that.
- Don't worry about perfect formatting or grammar - our team will help with that.

**Step 3: Save your work**

Expand Down
Loading
Loading