Skip to content

Commit

Permalink
Merge pull request #1830 from SEKOIA-IO/new-navigation
Browse files Browse the repository at this point in the history
New navigation content refresh
  • Loading branch information
ka0ula authored Jun 12, 2024
2 parents 118a8e9 + e5d0e2f commit a46dc3e
Show file tree
Hide file tree
Showing 25 changed files with 532 additions and 303 deletions.
25 changes: 11 additions & 14 deletions docs/getting_started/account_security.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,22 @@
# Set up account security
## Two-factor authentication
# Two-factor authentication

Two-Factor Authentication (2FA) provides an extra layer of security for your Sekoia.io account by introducing an additional step during the login process. In addition to your username and password, you will be required to provide a 6-digit verification code generated on your phone. This ensures enhanced protection against unauthorized access to your account.

### How do I enable two-factor authentication?

## Enabling Two-Factor Authentication

To enhance the security of your Sekoa.io account, you can enable Two-Factor Authentication (2FA) by following these instructions:
To enhance the security of your Sekoia account, you can enable Two-Factor Authentication (2FA) by following these instructions:

1. Begin by logging in to app.sekoia.io using your credentials
2. Click on your profile picture in the top right of the screen. From the dropdown menu, select `Account settings` to access the User Center
3. Within your Account page, scroll down until you find the section labeled `Register Two-Factor Authentication`. Click on the `Enable` button associated with it
1. Begin by logging in to app.sekoia.io
2. Click on your name in the navigation menu and select `Profile and security`
3. Within your profile page, scroll down until you find the section labeled `Register Two-Factor Authentication`. Click on the `Enable` button associated with it
4. You will be asked to enter your password for verification purposes
5. Follow the steps below to complete the setup process for 2FA on your account:
1. Visit either the App Store (for iOS) or the Play Store (for Android) to download and install an Authenticator app such as Lastpass, Authenticator, or Authy. Follow the instructions provided by the app to set up an account
2. Use the authentication app you installed to either scan the QR code displayed on app.sekoia.io or manually enter the token provided
3. Enter the `6-digit code` generated by the authentication app
6. Lastly, ensure that you generate and securely save your backup codes. These codes serve as a backup method to access your account in case you are unable to use the authentication app

### Generate backup codes
## Generate backup codes

If you lose your mobile device or cannot use your authenticator app, you can use backup codes provided by Sekoia.io to access your account. **Ten backup codes** are generated. Each code can only be used **once**.

Expand All @@ -29,7 +26,7 @@ You can also generate new backup codes but keep in mind that your old codes will

We recommend you print off and store your codes in a safe location.

### Log in with backup codes
## Log in with backup codes

To log in with your backup codes, you will need to:

Expand All @@ -38,13 +35,13 @@ To log in with your backup codes, you will need to:
3. Enter your `username` and `password`
4. When asked for your verification code, enter the backup code and select `verify`

### How to disable two-factor authentication
## How to disable two-factor authentication

To disable two-factor authentication on your SEKOIA account:
To disable two-factor authentication on your Sekoia account:

1. Log in to app.sekoia.io
2. Click on your profile picture and select `Account settings` to access the User center
3. In your Account page, scroll down to the section `Register Two-Factor Authentication` and click on `Enable`
2. Click on your name and select `Profile and security`
3. Within your profile page, scroll down to the section `Register Two-Factor Authentication` and click on `Enable`
4. Enter your current password and select `disable`

!!! Note
Expand Down
21 changes: 21 additions & 0 deletions docs/getting_started/account_settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Set up your account

Once your account is created, you will be directed to the Settings page. Here, you can personalize your account settings, enhance security, and manage your preferences.

### Account setup options

- Edit personal information: Change your profile picture by clicking on it and selecting a new picture from your files
- [Add layers of security](account_security.md): Enable additional security features such as two-factor authentication and security tokens to protect your account
- [Notification preferences](notifications-Listing_Creation.md): Set up your notification preferences to stay informed about important updates and activities

For more detailed guidance on navigating the platform and using its features, refer to the [Where to Start](concepts.md) section.

### Change theme of the application

To change the theme of your workspace, follow these steps:

1. Go to Settings
2. On the top of the menu, click on `Theme`
3. Select either Light theme or Dark theme

The change takes effect immediately and will be saved. Please note that this customization applies only to your account and does not affect the theme settings for other workspace members.
3 changes: 2 additions & 1 deletion docs/getting_started/authentication.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Authentication

The app is accessible through the URL [app.sekoia.io](http://app.sekoia.io). You’ll have to enter your email and password then hit Login.

We highly recommend using **2-factor authentication** to add a layer of security to your account. You can either use an Authentication app or a security token.

In case your forgot your password, you can hit the Forgot password link on the login page, enter your email address and wait until we send you a confirmation link to reset your password shortly after.
In case your forgot your password, you can hit the `Forgot password link` on the login page, enter your email address and wait until we send you a confirmation link to reset your password shortly after.

You can find the necessary documentation to set up the required security on this **page**.
18 changes: 0 additions & 18 deletions docs/getting_started/community-create_sub_com.md

This file was deleted.

26 changes: 0 additions & 26 deletions docs/getting_started/community-edit.md

This file was deleted.

94 changes: 94 additions & 0 deletions docs/getting_started/concepts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# Where to start

## Authentication

The app is accessible through the URL [app.sekoia.io](https://app.sekoia.io/). You’ll have to enter your email and password then hit Login.

We highly recommend using [2-factor authentication](account_security.md) to add a layer of security to your account. You can either use an Authentication app or a [security token](securitytokens.md).

In case your forgot your password, you can hit the “Forgot password link” on the login page, enter your email address and wait until we send you a confirmation link to reset your password shortly after.

!!! note
You can find the necessary documentation on how to set up the required security on this [page](account_security.md).


## Basic concepts

### Workspace

A **Workspace** is the central hub of your Sekoia.io application where all primary activities and operations occur. It serves as the main environment for managing your operational tasks, settings, and configurations. Each workspace can support multiple communities, making it flexible for both single and multi-tenant modes.

### Communities

**Communities** are subdivisions within a workspace that allow for more granular control and management of cybersecurity operations settings. They can function independently or inherit the configurations of their parent workspace. This flexibility is particularly useful for MSSPs who manage multiple clients or for organizations with distinct departments needing separate management and controls.

---

### TL;DR

**Workspace**: The main environment where everything happens. It includes all primary features operations, settings, and configurations.

**Community**: A sub-environment within a workspace. It can operate independently or inherit settings from the main workspace. It is useful for multi-tenant setups where different groups need separate configurations.

## Navigation

### Switch workspace and communities

The platform allows you to seamlessly switch between different workspaces and communities, ensuring that you can efficiently manage your tasks and collaborations.
Switching Workspaces

#### Switch workspace

To switch to a different workspace, follow these steps:

- Click on the current workspace name located at the top of the menu
- A dropdown list will appear, showing all available workspaces
- Select the desired workspace from the list to switch to it

#### Switching communities

For switching communities or selecting multiple communities, use the Communities button located in the breadcrumb:

1. Click on the Communities button in the breadcrumb navigation
2. A selection menu will appear, displaying all available communities
3. Check the boxes next to the communities you need to access to switch to the chosen communities

!!! note
The button Communities in the breadcrumb is only available to multi-tenant workspaces.


### Quick filters

On the main pages of the app, such as Alerts, Rules Catalog, Intakes, Playbooks, and Intelligence, a filter button exists to let you customize results displayed in complex tables. The `Filters` button enables you to refine and tailor the data according to your specific needs.

#### Enabling filters quickly

For quick access to the filter menu, simply press the "F" key on your keyboard. This shortcut will instantly open the filter menu, allowing you to start customizing your view without the need to navigate through additional menus.

#### Adding and using filters

- **Multiple Filters**: You can apply multiple filters to the same table. This allows you to narrow down the results based on various criteria simultaneously. For instance, you can filter by date range, status, and assigned user all at once.

- **Multi-Selection**: The filter menu supports multi-selection. This means you can select multiple values for a single filter criterion. For example, if you want to see alerts from several specific sources, you can select all relevant sources within the filter menu.


### Personalized menu

The platform offers a personalized menu feature, allowing you to customize the order and visibility of pages based on your profile and daily activities.

#### Adding pages to favorites

To enhance your workflow, you can add the pages you use most frequently to your favorites. These pages will then be pinned at the top of the menu for easy access. Simply click the star icon next to a page name to add it to your favorites list.

#### Organizing menu sections

The menu is divided into multiple sections, which you can reorganize according to your preferences. To rearrange these sections:

1. Click and hold the section header you wish to move
2. Drag the section to your desired position within the menu
3. Release the mouse button to drop the section in its new location

For example, if you use the Observe section more frequently, you can drag it to the top of the menu for quicker access.



18 changes: 11 additions & 7 deletions docs/getting_started/create_account.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
# Create your account

To create your new account, you will have to click on the link in the invitation email and you'll be redirected to the account creation form.
As mentionned in the [Join a workspace or a community](join_community.md) article, you need to be invited to join a workspace by a current user to be able to create an account.

From there, you'll have to:
## Step-by-step account creation

1. Provide your full name
2. Set a strong password
3. Agree to the Terms of Service
### Open the invitation email
1. Locate the invitation email sent to you by Sekoia.io
2. Click on the link provided in the email to be redirected to the account creation form

### Complete the Account creation form
1. Provide your full name: Enter your full name in the designated field
2. Set a strong password: Create a strong password that meets the platform’s security requirements
3. Agree to the Terms of Service: Read and agree to the Terms of Service by checking the appropriate box
4. Click the `Create Account button` to finalize the creation of your account

Once your account is created, you land in the User Center which is the place where you can setup your account, add layers of security and privacy, set notifications and manage your communities.

The User Center is accessible by clicking on your avatar on the upper right part of the screen. Learn more about navigation on the platform in this article.
53 changes: 53 additions & 0 deletions docs/getting_started/create_community.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Create and edit communities

## Types of users

### Single-tenant users
For single-tenant users, a workspace is automatically created upon subscribing to Sekoia. Users can only have one Workspace, which does not contain any communities.

### Multi-tenant users
For multi-tenant users, such as Managed Security Service Providers (MSSPs), a primary workspace is created. These users can add multiple communities to manage their various clients or departments.

!!! info
To access multi-tenant mode, contact your Sekoia account executive. Once subscribed, you will be switched to multi-tenant mode in the following days.

## How to create a community

To create a new community in a multi-tenant mode, you must have the necessary role and permissions.

Follow these steps to create a community:

1. In the main navigation, click on `Settings`
2. In the `workspace` section, click on `Add new community` button in the left panel that lists workspace and communities
3. Fill in the required details such as the name and a description. The website field is optional
4. Save changes

The newly created community will now appear in the communities listing.

## How to edit a community

To edit an existing community details, follow these steps:

1. Navigate to the community you wish to edit
2. Click the `Edit button` to modify the name, description, and website
3. To change the community image, click on the profile picture and select a new one from your files

### Steps to edit community details

#### Edit name and description

1. Click the Edit button next to the community name
2. Update the name and description fields as needed
3. Click Save to apply your changes

#### Change community image
1. Click on the current profile picture
2. Select a new image from your files
3. Click Save to update the profile picture

By following these steps, you can easily manage and customize your communities to better align with your organizational needs and branding.

## How to add and remove users

To learn more about how to add and remove users, please follow this documentation on [Users and Roles](invite_users.md).

33 changes: 33 additions & 0 deletions docs/getting_started/custom_roles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Custom roles

## Creating a custom role

To create a custom role, follow these steps:

1. Go to Settings > Workspace > Roles
2. Click on the Add New Role button
3. Provide role details:
- Role name: Enter a name for the new role
- Description: Write a description between 10 and 1000 characters to explain the purpose and responsibilities associated with this role
4. Choose the specific permissions you want to assign to this role. These permissions will define what actions users with this role can perform
5. Click Save to create the role. The new role will now appear in the roles listing.

## Assigning the custom role to users

Once the custom role is created, you can assign it to existing users:

1. Navigate to the Workspace users page in the settings menu
2. Select the user you want to assign the role to
3. Attribute the new custom role to the user and save your changes

## Important considerations

### Disabling built-in roles

When you assign a custom role to a user, any built-in roles previously assigned to that user will be disabled. Ensure that the custom role includes all necessary permissions for the user’s responsibilities.

### Multiple custom roles

You can add multiple custom roles to a single user. This allows you to combine permissions from different roles to create a comprehensive permission set for the user.

By creating and managing custom roles, you can ensure that your users have the precise permissions they need to perform their tasks efficiently and securely.
25 changes: 13 additions & 12 deletions docs/getting_started/get_troubleshooting_tips.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Get Troubleshooting Tips
# Troubleshooting Tips

If you're having trouble signing in to Sekoia, get more information about signing in issues and fixing them.

Expand All @@ -10,20 +10,21 @@ If Sekoia.io can't maintain WebSocket connections on the browser, the web applic

#### Troubleshooting Steps

Step 1: Contact your network administrator
**Step 1: Contact your network administrator**

Contact your network administrator to make sure they support WebSocket connections. Also ask it to review login attempts to the following url: app.sekoia.io/live
Contact your network administrator to make sure they support WebSocket connections. Also ask it to review login attempts to the following URL: [app.sekoia.io/live](app.sekoia.io/live)

Step 2: Collect and send us network logs
**Step 2: Collect and send us network logs**

If the problem persists, collect and send the network logs to us so we can investigate the situation further. You can collect network logs through through Google Chrome.

1. Open Google Chrome and navigate to the following link: chrome://net-export/.
2. Click Start Logging to Disk.
3. Save the file as sekoiaNetlog.
4. In another Chrome tab, open your Sekoia workspace.
5. Use Sekoia as you normally do. When the problem occurs, go back to the chrome://net-export/ tab and click Stop Logging.
6. Find the sekoiaNetlog file in the Downloads folder on your computer.
7. Send us a message with the file attached.
1. Open Google Chrome and navigate to the following link: chrome://net-export/
2. Click Start Logging to Disk
3. Save the file as sekoiaNetlog
4. In another Chrome tab, open your Sekoia workspace
5. Use Sekoia as you normally do. When the problem occurs, go back to the chrome://net-export/ tab and click Stop Logging
6. Find the sekoiaNetlog file in the Downloads folder on your computer
7. Send us a message with the file attached

Note: If you don't use Chrome as your browser, send us a message and we'll help you resolve the issue.
!!! note
If you don't use Chrome as your browser, send us a message and we'll help you resolve the issue.
Loading

0 comments on commit a46dc3e

Please sign in to comment.