Skip to content

Commit

Permalink
Merge pull request #57 from lukso-network/update-dashboard-screen
Browse files Browse the repository at this point in the history
Update 2FA dashboard screens
  • Loading branch information
Hugoo authored Feb 5, 2024
2 parents c1e332c + a253b95 commit 4f4d422
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 28 deletions.
16 changes: 12 additions & 4 deletions docs/extension/controllers.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,21 @@ We are working on a feature to add controllers using previously saved private ke

:::

## Can I add 2FA recovery to an existing Universal Profile?
## How can I add 2FA recovery to an existing Universal Profile?

At the current state (11th January 2024), the 2FA recovery method from LUKSO can only be added during the creation of a Universal Profile on [UniversalProfile.cloud](https://universalprofile.cloud/).
To check the 2FA recovery status and add 2FA, please visit the dashboard on [my.universalprofile.cloud](https://my.universalprofile.cloud/). The Universal Profile card will show the current **2FA recovery status** at the top right corner. If 2FA has not been added yet, continue by clicking the **Add Recovery** button.

:::success Upcoming Feature
![2FA Recovery Dashboard](/img/general/recovery-dashboard.png)

:::info

The 2FA recovery feature is only available for Universal Profiles directly created on [universalprofile.cloud](https://my.universalprofile.cloud/) and that can still be accessed within a Universal Profile Browser Extension. If you lost access before adding 2FA recovery, you can only recover the Universal Profile by using **File Backup**.

:::

:::note Dashboard Refresh

Due to the [Controller Incident](./incidents/controller-recovery.md) of the Universal Profile Extension in January 2024, we are currently working on a way to let non-2FA profiles add recovery within the dashboard of [my.universalprofile.cloud](https://my.universalprofile.cloud/).
If the dashboard is not showing the _recovery indicators_ or _Add Recovery_ button, please **refresh or disconnect** and log-in again using your Universal Profile Browser Extension.

:::

Expand Down
24 changes: 4 additions & 20 deletions docs/extension/guides/check-2fa-recovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ If you visit the controller menu in the Universal Profile Browser Extension, the
- The Universal Receiver (used to write asset updates on the profile)
- The Universal Profile Recovery (used as a backup for the profile)

To confirm that the permissions of the recovery controller were adequately set up, click on the controller of the Universal Profile Recovery and verify that the **Add Controller** permission is enabled.
To confirm that the permissions of the recovery controller were [adequately set up](../controllers.md#what-are-the-default-permissions-of-the-controllers), click on the controller of the Universal Profile Recovery and verify that the **Add Controller** permission is enabled.

<div style={{textAlign: 'center'}}>

Expand All @@ -34,27 +34,11 @@ The names of the controllers can vary, depending on the time of your Universal P

:::

## Verify the recovery controller on the profile explorer
## Verify the recovery controller on the dashboard

Next, we must check if the recovery was successfully added via the LUKSO Relay Service.
Next, please check if the recovery was successfully added via the LUKSO Relay Service by logging into the dashboard of [my.universalprofile.cloud](https://my.universalprofile.cloud/). If 2FA was successfully added, the profile card will show a green checkmark at the top right corner:

1. **Copy the address of your Universal Profile Recovery** from the controller menu of the Universal Profile Extension
2. Open the profile explorer on [UniversalProfile.cloud](https://universalprofile.cloud/?network=mainnet).
3. **Input the address** of the Universal Profile Recovery **into the search bar**.

If it was successfully added, it will show a recovery profile as in the following picture:

<img
src="/img/extension/recovery-search.png"
alt="Recovery Search"
width="500"
/>

:::info Recovery Name

The name of the Universal Recovery controller can vary, depending on the time of your Universal Profile creation.

:::
![2FA Recovery Dashboard](/img/general/recovery-dashboard.png)

:::caution

Expand Down
4 changes: 2 additions & 2 deletions docs/extension/guides/create-backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: 'Extension Support: Create Backup'

If you lost access to the Universal Profile Browser Extension, there are multiple ways to secure your Universal Profile :

- **2FA**: You can set up 2FA while creating the Universal Profile on [UniversalProfile.cloud](https://universalprofile.cloud/). 2FA is the recommended way of backing up a Universal Profile and will add a new recovery controller to the profile, secured on LUKSO's end. This controller has permission to add new controllers if access to an old extension is lost. For security reasons, users must provide an authentication code from a mobile device and approve via email before a new controller can be added using LUKSO's recovery service.
- **2FA**: You can set up 2FA for the Universal Profile on [UniversalProfile.cloud](https://universalprofile.cloud/). 2FA is the recommended way of backing up a Universal Profile and will add a new recovery controller to the profile, secured on LUKSO's end. This controller has permission to add new controllers if access to an old extension is lost. For security reasons, users must provide an authentication code from a mobile device and approve via email before a new controller can be added using LUKSO's recovery service.
- **QR Import**: You can import any Universal Profile address into your extension. The import process will create a new local controller. Before it can can be used, the new controller needs to added to the Universal Profile by one of your existing controllers with sufficient permissions. Within the new extension, you will receive a QR code of a transaction that can be scanned or copied. When this QR code is received and the related transaction executed by an existing extension, this new controller will gain permissions on the Universal Profile.
- **File Export**: You can export the Universal Profile directly as a text file, including the private key of the extension's controller. Make sure to store it somewhere safe. This private key will allow you to regain access to the profiles and their current controllers within the Universal Profiles.

Expand All @@ -32,7 +32,7 @@ Due to the nature of [backups and recovery](../controllers.md#what-happens-durin

:::caution

The Universal Profile Browser Extension currently does not feature a way to import profiles using the plain private key described in _File Export_. Therefore, we **recommend setting up 2FA** during creation. Optionally, the private key of a controller (EOA) could be imported into a regular wallet to send transactions manually. You can find further information in the [Controller](../controllers.md) section.
The Universal Profile Browser Extension currently does not feature a way to import profiles using the plain private key described in _File Export_. Therefore, we **recommend [setting up 2FA](../controllers.md#how-can-i-add-2fa-recovery-to-an-existing-universal-profile)**. Optionally, the private key of a controller (EOA) could be imported into a regular wallet to send transactions manually. You can find further information in the [Controller](../controllers.md) section.

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/general/universal-profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ If you are logged in, you will also be able to transfer assets:

## Where can I manage my Universal Profile?

You can connect your Universal Profile to [my.universalprofile.cloud](https://my.universalprofile.cloud/) to manage recovery or create new profiles.
You can connect your Universal Profile to [my.universalprofile.cloud](https://my.universalprofile.cloud/) to check and add 2FA recovery or create new profiles.

![Universal Profile Management](../../static/img/general/my-up.png)
![Universal Profile Management](../../static/img/general/recovery-dashboard.png)

## Is my Universal Profile name unique?

Expand Down
Binary file removed static/img/general/my-up.png
Binary file not shown.
Binary file added static/img/general/recovery-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4f4d422

Please sign in to comment.