Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: managing e2ee [INS-3969] #209

Merged
merged 1 commit into from
Jun 7, 2024
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
2 changes: 2 additions & 0 deletions docs/_data/main-nav.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ toc:
url: /insomnia/accounts
- title: Forgotten Passphrase
url: /insomnia/forgot-passphrase
- title: Managing E2EE (End-to-End Encryption)
url: /insomnia/managing-e2ee
- title: Insomnia Organizations
collapse-id: organizations
items:
Expand Down
Binary file added docs/assets/images/disable-e2ee.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/assets/images/enable-e2ee.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
62 changes: 62 additions & 0 deletions docs/insomnia/managing-e2ee.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
layout: article-detail
title: Managing E2EE (End-to-End Encryption)
category: "Insomnia Accounts"
category-url: managing-e2ee
---

This tutorial will guide you through enabling or disabling E2EE in the Insomnia app, along with some critical considerations about handling your passphrase.

By default, accounts created from June 4th 2024 onwards with a free subscription have E2EE disabled. While your data remains encrypted at rest and in transit, E2EE offers an additional layer of security by encrypting data such that only the parties involved in the communication can decrypt it.

### Enabling E2EE

If you decide you want the additional security layer of E2EE, follow these steps to enable it:

#### Step 1: Access Account Settings

- **Log in** to your Insomnia App.
- Navigate to **Account Settings**, usually accessible from the dropdown menu under your account name.

#### Step 2: Navigate to Encryption Settings

- Once in Account Settings, look for the **Encryption** section.
- Click on **"Encryption"** to access the encryption options.

#### Step 3: Enable E2EE

- In the Encryption section, you will find an option to **Enable E2EE**.
- Click on **"Enable E2EE"** to start the setup process.

#### Step 4: Set Up Your Passphrase

- Once you enable E2EE, you will be prompted to **define a passphrase**. Enter your desired passphrase.
- **Confirm your passphrase** by entering it again. Ensure it is strong and memorable.

![enable-e2ee](../assets/images/enable-e2ee.png)

When enabling E2EE, there are several important factors to consider:

- **Backup Your Passphrase**: Always keep a backup of your passphrase in a secure location. Without it, you cannot recover your data.
- **Data Loss Risks**: Losing your passphrase means losing access to any encrypted data for which you do not have a backup.
- **Impact on Organizational Access**: If you own or are part of an organization within Insomnia, enabling E2EE will remove any users from your organization who do not have E2EE enabled.

### Disabling E2EE

If you decide you don't want to maintain passphrase any longer or make use of the additional security layer of E2EE, follow these steps to disable it:

#### Step 1: Go to Encryption settings

- **Log in** to your Insomnia App.
- Navigate to **Account Settings**, usually accessible from the dropdown menu under your account name.
- Once in Account Settings, look for the **Encryption** section.
- Click on **"Encryption"** to access the encryption options.

#### Step 2: Disable E2EE

- In the Encryption section, you will find an option to **Disable E2EE** next to an option to **Reset passphrase**.
- **Confirm your current passphrase** and then disable it.

![disable-e2ee](../assets/images/disable-e2ee.png)

Keep in mind: By disabling end-to-end encryption, your data will still be encrypted with a managed key by Insomnia but you won't be asked for a passphrase anymore.
Loading