Skip to content
This repository was archived by the owner on Aug 13, 2025. It is now read-only.
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
10 changes: 5 additions & 5 deletions docs/manual/concepts/secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ description: Olares secrets management system principles, detailing vault items,

Olares categorizes secrets based on usage scenarios and employs various management techniques.

| | Data Type | Storage Location | Leak Risk | Usage |
|-------------|--------------------------------------------------------------------------------------|-------------------------------------|--------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| Vault items | Includes website and database passwords, blockchain private keys, etc. | Vault | Encrypted data in Olares ensures that third parties cannot view even upon logging in | Each use requires a signature from LarePass |
| Credentials | System access credentials obtained post-secure authentication: Tokens, Cookies, etc. | [Infisical](https://infisical.com/) | Viewable by third parties post-authentication in Olares by following specific steps | Available to applications through an API after obtaining Provider permissions |
| Secret | Sensitive data used in Pod containers, like database connections and admin accounts | ETCD | Directly visible in [Control Hub](../olares/controlhub/navigate-control-hub#secrets) | Used in Helm deployment templates; secret values are injected into environment variables via valueFrom -> secretKeyRef |
| | Data Type | Storage Location | Leak Risk | Usage |
|-------------|----------------------------------------------------------------------------------------------------------|-------------------------------------|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| Vault items | Includes website and <br/>database passwords, <br/>blockchain private <br/>keys, etc. | Vault | Encrypted data in Olares ensures that third parties cannot view even upon logging in | Each use requires a signature from LarePass |
| Credentials | System access <br/>credentials obtained<br/> post-secure<br/> authentication:<br/> Tokens, Cookies, etc. | [Infisical](https://infisical.com/) | Viewable by third parties post-authentication in Olares by following specific steps | Available to applications through an API after obtaining Provider permissions |
| Secret | Sensitive data used<br/> in Pod containers,<br/> like database <br/>connections and <br/> admin accounts | ETCD | Directly visible in [Control Hub](../olares/controlhub/navigate-control-hub#secrets) | Used in Helm deployment templates; secret values are injected into environment variables via valueFrom -> secretKeyRef |

## Integration credential

Expand Down
2 changes: 1 addition & 1 deletion docs/manual/get-started/next-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Here are some suggested next steps:
{ text: 'Steam', href: '/use-cases/stream-game' }
]"
buttonText="Learn more"
buttonLink="../use-cases/"
buttonLink="/use-cases/"
/>

<!-- Card 2 -->
Expand Down
24 changes: 16 additions & 8 deletions docs/manual/larepass/activate-olares.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,22 @@ description: Learn how to activate Olares for the first time, reactivate it afte

# Activate Olares

Olares uses your **Olares ID** and the **LarePass mobile app** to provide a secure and seamless authentication experience. This document walks you guides you on how to activate Olares and complete two-factor verification during login using LarePass.
Olares uses your **Olares ID** and the **LarePass mobile app** to provide a secure and seamless authentication experience. This document guides you on how to activate Olares and complete two-factor verification during login using LarePass.

## Activate for the first time
:::warning Same network required for admin users
To avoid activation failures, ensure that both your phone and the Olares device are connected to the same network.
:::

## Activate Olares for the first time
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the current installation script method, users need to scan a QR code for activation. For future hardware users, they will first need to scan for the device on their LAN, and then can activate it without needing to scan a QR code.
Consider adding another section?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah there should be a dedicated section for hardware users.


After [completing the installation](../get-started/install-olares.md#install-olares) and initial setup in the wizard, you can activate your Olares instance using your Olares ID through the **LarePass** app.

::: tip Note
New members can activate their account through the wizard without installing Olares locally. See [Create a new member](../olares/settings/manage-team.md#create-a-new-member) for more information.
:::

After completing the installation and initial setup in the wizard, you can activate your Olares instance using your Olares ID through the **LarePass** app.

![2FA](/images/larepass/activate-olares.png#bordered)
![2FA](/images/manual/larepass/activate-olares.png#bordered)

1. Open LarePass app.
2. Tap **Scan QR code** to scan the QR code on the Wizard page.
Expand All @@ -31,14 +40,13 @@ If you have reinstalled Olares, the original instance becomes unavailable. You c

When you log in to Olares, you will be promoted to complete the two-factor verification. You can either confirm the login directly in LarePass app or manually enter a 6-digit verification code.

![2FA](/images/larepass/second-confirmation.png#bordered)

- **To confirm login on LarePass**:

![2FA](/images/manual/larepass/second-confirmation.png#bordered)
1. Open the login notification on your phone.
2. In the message, click **Confirm** to complete the login process.

- **To manually enter the verification code**:
![OTP](/images/manual/larepass/otp-larepass.jpg#bordered)

1. On the Wizard page, select **Verify using one time password from LarePass**.
2. Open LarePass on your phone and go to **Settings**.
Expand All @@ -49,4 +57,4 @@ When you log in to Olares, you will be promoted to complete the two-factor verif
The verification code is time-sensitive. Ensure you enter it before it expires. If it does, you will need to generate a new code.
:::

After successful verification, you'll be redirected to the Olares desktop.
After successful verification, you'll be redirected to the Olares desktop.
12 changes: 6 additions & 6 deletions docs/manual/larepass/create-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
outline: [2, 4]
---

# Create Olares ID
# Create and manage accounts

Managing Olares accounts is a core function of LarePass. If you are new to Olares, you will need to start by creating an Olares ID. This guide walks you through the process, and other commonly used account operations as well.

Expand All @@ -26,7 +26,7 @@ To create an individual Olares ID quickly:
2. Enter your desired Olares ID. It must be at least 8 characters long and contain only lowercase letters and numbers.
3. Click **Continue** to finish the creation process.

![Fast creation](/images/larepass/create-olares-id.png)
![Fast creation](/images/manual/larepass/create-olares-id.png)

After you get your Olares ID, wait for [Olares installation](../get-started/install-olares.md) to complete, then proceed with [activation](../get-started/activate-olares.md).

Expand All @@ -42,10 +42,10 @@ Olares currently supports VC via Google Gmail. For details, refer to the [Gmail
1. In the LarePass app, tap **Create an account**.
2. On the account creation page, tap <i class="material-symbols-outlined">display_settings</i> in the top-right corner.
3. In the **Advanced account creation** page, tap **Individual Olares ID**.
![Advanced account creation](/images/larepass/advanced_creation.png)
![Advanced account creation](/images/manual/larepass/advanced_creation.png)
4. Tap the Gmail VC option. Authenticate using your Gmail account as promoted, and then click **Continue**.
5. Wait for the binding to complete, then click **Continue** to view your Olares ID information.
![Olares ID with VC](/images/larepass/individual_olares_id_vc.png)
![Olares ID with VC](/images/manual/larepass/individual_olares_id_vc.png)
</template>
<template #Organization-Olares-ID>

Expand All @@ -55,11 +55,11 @@ You must have already [set up a custom domain in Olares Space](/space/host-domai
1. In the LarePass app, tap **Create an account**.
1. On the account creation page, tap <i class="material-symbols-outlined">display_settings</i> in the top-right corner.
2. In the **Advanced account creation** page, tap **Organization Olares ID** > **Join an existing organization**.
![Advanced account creation](/images/larepass/advanced_creation_org.png)
![Advanced account creation](/images/manual/larepass/advanced_creation_org.png)
3. Enter your organization's domain name and click **Continue**.
4. Bind the VC via your email accounts. Currently, only Gmail and Google Workspace email are supported.

![Org ID VC](/images/larepass/organization_olares_id.png)
![Org ID VC](/images/manual/larepass/organization_olares_id.png)

Upon completion, you will receive an Organization Olares ID.
</template>
Expand Down
2 changes: 1 addition & 1 deletion docs/manual/larepass/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ outline: [2, 3]

LarePass is the official cross-platform client software for Olares. It acts as a secure bridge between users and their Olares systems, enabling seamless access, identity management, file synchronization, and secure data workflows across all your devices, whether you're on mobile, desktop, or browser.

![LarePass](/images/larepass/larepass.png)
![LarePass](/images/manual/larepass/larepass.png)


## Key features
Expand Down
4 changes: 2 additions & 2 deletions docs/manual/larepass/integrations.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
outline: [2, 3]
description: Connect Olares Space and third-party services to enhance functionality. Learn how to integrate, authorize, and manage connected services for seamless data synchronization.
description: Connect Olares with third-party services to enhance functionality. Learn how to integrate, authorize, and manage connected services for seamless data synchronization.
---

# Manage integrations in LarePass

LarePass is your central hub for connecting Olares with both first-party services like Olares Space and third-party services like Google Drive, Dropbox, AWS S3, and Tencent COS. These integrations extend the capabilities of your Olares environment like file sync, secure backup, and more.
LarePass is your central hub for connecting Olares with third-party services like Google Drive, Dropbox, AWS S3, and Tencent COS. These integrations extend the capabilities of your Olares environment like file sync, secure backup, and more.

:::info
We're working on adding support for more third-party integrations that will connect you with more external services to your Olares account.
Expand Down
57 changes: 37 additions & 20 deletions docs/manual/larepass/manage-olares.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Manage Olares with LarePass

The LarePass app allows you to easily manage your Olares device remotely. You can monitor system status, manage network connections, perform remote controls, and access key device information from your phone.
The LarePass app allows you to easily manage your Olares device. You can monitor system status, manage network connections, perform remote controls, and access key device information from your phone.

This guide walks you through the core management features available in LarePass.

Expand All @@ -24,21 +24,26 @@ To access the Olares management page:

In the upper-right corner of the Olares management page, tap the <i class="material-symbols-outlined">power_settings_new</i> icon to access remote control options:

- **Restart Olares** – Reboots the device. Status will show `Restarting`... and revert to Running after approximately 5–8 minutes.
- **Shutdown Olares** – Powers off the device. Status will display `Powered Off`. You must turn it on manually afterward.
![Device control](/images/manual/larepass/device-control.png)

- **Restart device** – Reboots the device. Status will show `Restarting`... and revert to `Olares Running` after approximately 5–8 minutes.
- **Remote shutdown** – Powers off the device. Status will display `Powered off`. You must turn it on manually afterward.

## Configure network

Tap **Wi-Fi configuration** to view or modify the current network settings of your Olares device.

### Switch from wired to wireless network

If Olares was activated over Ethernet, you can switch to the connected Wi-Fi on the same network:
If Olares was activated over Ethernet, you can switch to the Wi-Fi on the same network:

![Wi-Fi switch](/images/manual/larepass/switch-wifi.jpg)

1. Tap the **Wi-Fi configuration** option to enter the network selection page.
2. Tap the Wi-Fi network from the list. If the network is password-protected, enter the password and tap **Confirm**.
3. Once connected, the network switches to Wi-Fi automatically. The transition takes approximately 5 minutes. The Olares status will change to `IP changing` before it reverts to `Olares Running`.

1. On the **Wi-Fi configuration** screen, select the Wi-Fi network from the list.
2. If the network is secured, enter the password and confirm.
3. Once connected, the Wi-Fi network will appear under the **Available connections** list.
4. Tap the new Wi-Fi option to switch. Status will change to `IP changing` and return to `Running` after about 5 minutes.
You can switch back to the wired network following the same steps.

::: tip Wired network recommended
To ensure an optimal and stable connection, we recommend using a wired network whenever possible.
Expand All @@ -48,30 +53,42 @@ To ensure an optimal and stable connection, we recommend using a wired network w

If your Olares device moves to a different network:

1. Connect Olares and your phone to the new network and power on Olares.
2. Open LarePass and go to the **Olares management** page.
3. LarePass will automatically scan Olares device within the local network. When found, Olares will appear as `IP changing` in LarePass.
4. Once IP update finishes, the status will change to `Olares running`. This process may take 5–10 minutes.
1. Connect the Olares device to your wired network via Ethernet and power it on. Ensure your phone is connected to the Wi-Fi for that same network.
2. Open LarePass on your phone and go to the **Olares management** page.
3. LarePass will automatically scan Olares device within the network. When found, Olares will appear as `IP changing` in LarePass.
4. Once IP update finishes, the status will revert to `Olares running`. This process may take 5–10 minutes.

## View device information
### Set Wi-Fi via Bluetooth

Tap the device information area at the top of the Olares management screen to view:
If you can't connect your Olares to a wired network during activation, or if Olares is on a different wired network than your phone, LarePass won't be able to find it. This can prevent you from completing activation or device management. In such cases, use the **Bluetooth network configuration** feature to connect your Olares to your phone's Wi-Fi network.
![Bluetooth network](/images/manual/larepass/bluetooth-network.png)

- Hardware details
- System version
- Resource usage
- Connected network
1. On the **Olares not found** page, tap the **Bluetooth network configuration** option. LarePass will use your phone's Bluetooth to scan for the nearby Olares device that match your current Olares ID.
2. When your device is found, tap **Network configuration**.
3. From the list of wireless networks available to your Olares, tap the Wi-Fi network your phone is connected to. If it's password-protected, enter the password and tap **Confirm**.

::: tip Note
If you select a Wi-Fi network different from your phone's, LarePass will still be unable to recognize your Olares device after it connects.
:::

4. Olares will begin the network switching process. You'll see a success message when it's complete. If you return to the Bluetooth network setup page, you'll see that Olares' IP address has changed to your phone's Wi-Fi subnet.
::: tip Note
The process takes longer if your Olares was activated earlier as the network switch affects more services.
:::
5. Go back to the device scan page, and you will now be able to discover your Olares device. You can now proceed with [device activation](activate-olares.md) or device management as instructed in this document.

## Uninstall Olares

This will reset your device to the prepared installation phase, where you can scan the LAN to re-install and activate Olares.

![Uninstall Olares](/images/manual/larepass/restore-to-factory.png)

::: warning Proceed with caution
This will permanently delete all your accounts info and data. Proceed with caution.
:::

1. On the **Olares management** page, tap **Restore to Factory Settings**.

2. Review the risk prompt and enter your local LarePass lock screen password. If not set, you will be prompted to create one first.
2. Review the risk prompt and enter your local LarePass lock screen password. If not set, you will be prompted to set one first.

3. Wait for the uninstallation to complete. You will be returned to the Olares ID login screen.
3. Wait for the uninstallation to complete. You will return to the Olares login screen when it's done.
Loading