Skip to content

Commit

Permalink
Merge pull request #72 from cybsecmaster/feature/doc-72
Browse files Browse the repository at this point in the history
  • Loading branch information
jeromeleonard authored Nov 8, 2024
2 parents 326f6b2 + 9f417d8 commit 6a239ec
Show file tree
Hide file tree
Showing 12 changed files with 76 additions and 31 deletions.
Binary file modified docs/thehive/images/installation/copy-challenge.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/thehive/images/installation/license1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/thehive/images/installation/license2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/thehive/images/installation/license3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/thehive/images/installation/license4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/thehive/images/installation/license5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/thehive/images/installation/license6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/thehive/images/installation/license7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/thehive/images/installation/license8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/thehive/images/installation/license9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/thehive/images/installation/update-license-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
107 changes: 76 additions & 31 deletions docs/thehive/installation/activate-license.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,103 @@
# Activating TheHive License

This section provides information about updating your license for TheHive. By default, TheHive is installed with the community edition license.
With version 5.3 and later, TheHive is provided with a 14-day **Platinum trial**, which supports up to 2 organizations and 5 users. After this trial period, TheHive transitions to read-only mode, requiring a valid license for continued full functionality. All users are required to generate a valid license on StrangeBee's portal to use the platform.

To activate a different license, you need to purchase one from StrangeBee. Upon purchasing, StrangeBee will create an account for you on their customer portal, allowing you to activate your license.
A free *Community license* with essential features is available. Paid licenses providing access to advanced features are also available, by [contacting us](https://strangebee.com/contact-strangebee/){target=_blank}.

!!! Note
If you are already using TheHive 5.x Community version, please create your account on the License Portal before upgrading to version 5.3 or later. Without this Community License, your interface will be limited to read-only mode.

---

## Activating Your License
## How to Request a Free Community License

Follow these steps to activate your license:
### 1. Create an Account on the StrangeBee License Portal

1. **Access the Platform Management Page**:
- Navigate to the Platform Management page.
- Go to the **License** tab.
- Click the **Update the current license** button.

![Update License Button](../images/installation/update-license-button.png)
Visit the [StrangeBee License Portal registration page](https://portal.apps.strangebee.com/account/register){target=_blank}, and register using your professional email address.

2. **Copy the Challenge**:
- A window will open displaying the challenge.
- Click **Copy this challenge**.
![](../images/installation/license1.png)

![Copy Challenge](../images/installation/copy-challenge.png)
 

You will see a message confirming that the challenge has been copied.
### 2. Confirm Your Email Address

3. **Activate the License on the Customer Portal**:
- Log in to your account on the StrangeBee customer portal.
- Use the copied challenge to activate the license.
- The portal will provide you with an activation license key.
Check your email inbox for a confirmation message, click the confirmation link to verify your email address, and wait for your account to be validated by the StrangeBee team.

4. **Enter the Activation Key**:
- Return to the Platform Management page.
- Enter the activation key in the **License** field.
- Click the **Activate the license key** button.
![](../images/installation/license3.png)

This will activate your license and update your instance with all the features included in your license.
 

### 3. Set Up Your Password

Once your account is validated, you will receive a notification. Follow the instructions to configure your password.

---

## License Capabilities
![](../images/installation/license5.png)

The license includes the following capabilities:

- Defines the number of users you can create on your platform.
- Based on the number of users and the number of organizations.
- Includes a validation and an expiration date.
- Allows an unlimited number of Unlicensed users and Service users. Service users can use an API key to call all APIs but do not have access to TheHive interface.

---
 

### 4. Log In to the StrangeBee License Portal

Log in to the portal using your credentials.

![](../images/installation/license6.png)

 

### 5. Request a Community License

Click on **"Request a Community License"** to proceed to the license generation page.

![](../images/installation/license7.png)

 

![](../images/installation/license8.png)

 

## How to activate your license

!!! Note
This procedure applies to both Community and Gold/Platinum licenses.

### 1. Retrieve the Challenge from Your TheHive Instance

Open your TheHive instance in a new browser tab, navigate to **Admin > Platform Management > License Management**, and click **"Update the current license"** to display the challenge.

![](../images/installation/update-license-button.png)

 

### 2. Generate Your License Key

Copy the **Challenge** from TheHive, return to the StrangeBee License Portal, and paste it into the corresponding field on the license request page. Submit the form to generate your license key.

![](../images/installation/copy-challenge.png)

 

![](../images/installation/license9.png)

 

### 3. Activate Your License in TheHive

Copy the generated license key, go back to your TheHive instance, paste the license key into the appropriate field, and confirm to activate your Community License.

![](../images/installation/license4.png)

## How-to Guide
 

Below is a video guide that walks you through the process of activating your license in detail.
### 4. Enjoy TheHive Community Version

![type:video](../images/installation/activate-license.mp4)
Your TheHive Community edition is now fully activated. You can now explore and use all the features available to you.

 
 

0 comments on commit 6a239ec

Please sign in to comment.