User Manual

User Settings Main Page

This page allows you to manage your awaBerry account settings, including security, subscriptions, usage, and data management.

User Settings Main Page

Summary

The 'User Settings Main Page' is your central hub for managing all aspects of your awaBerry account. From here, you can review your account information, manage your license, enhance security with Two-Factor Authentication, configure advanced intelligence features with your own Google Gemini API key, set up personal S3 storage for file uploads, access your stored data report, find support resources, and manage critical account actions like uninstallation or deletion.

Page Access

You can access this page by navigating to: /user_main

Page Functionalities

User Account Information

This section displays your registered email address and provides essential account management options.

  • Your email address: See the email associated with your awaBerry account.
  • Password change instruction: A helpful note explaining how to change your password by logging out and using the "Forgot password" link.
  • "Logout user" button: Safely logs you out of the awaBerry application.

Current License & Subscription

Provides an overview of your active awaBerry license and subscription details.

  • Displays your current license type, features, and expiry information.

Two-Factor Authentication (2FA)

Manage the security of your account with Two-Factor Authentication.

  • Current Status: Indicates whether 2FA is "Enabled" (secure) or "Disabled" for your account.
  • "Edit two factor authentication" button / Toggle switch: Click or toggle to initiate the setup or deactivation process for 2FA, adding a critical layer of security to protect your encryption keys.

Today's Usage Statistics

Get a comprehensive view of your daily usage of awaBerry's license features.

  • Detailed metrics: Shows statistics such as remote session time, intelligent terminal commands executed, and file browser transfers.
  • Note: This section is only visible if you have an active awaBerry license that supports tracking these features (i.e., not a basic 'connect' license).

Google Gemini API Key for Intelligence

Configure your own Google Gemini API key to unlock unlimited intelligence routines within awaBerry.

  • Current Status: Shows if you are currently using your own Google Gemini API key.
  • "Setup your own Google Studio API key" button / Toggle switch: Use this to provide and configure your personal Google Gemini API key.
  • Important Note: For secure storage of your API key, Two-Factor Authentication must be enabled on your account before you can set this up.

S3 Storage Configuration

Set up your personal S3-compatible cloud storage for unlimited file uploads.

  • Current Status: Indicates whether you are using your own S3-compatible storage.
  • "Setup S3 Storage" button / Toggle switch: Click or toggle to configure your preferred S3 storage provider (e.g., AWS, Cloudflare R2, DigitalOcean Spaces, Backblaze B2, IONOS S3, or a custom URL), bucket name, region, access key, and secret key.
  • Important Note: Similar to the Google API Key, Two-Factor Authentication is required to securely encrypt and store your S3 credentials in the awaBerry cloud.

View Stored Data (GDPR)

Access a detailed report of all data stored in your awaBerry account for transparency and compliance.

  • "Open report" button: Click to navigate to a dedicated page where you can download and review a comprehensive report of your personal data stored by awaBerry, adhering to GDPR compliance.

awaBerry Support

Direct links to help and support resources.

  • "User Manual" link: Opens the official awaBerry user manual in your web browser.
  • "Contact Form" link: Access a form to directly contact awaBerry support for general inquiries or assistance.
  • "Report a Bug" link: Use this link to submit a report for any issues or bugs you encounter in the application.
  • "Report Abuse" link: Provides a way to report any misuse or abuse observed within the awaBerry platform.

Danger Zone

This section contains irreversible actions that can lead to data loss or require re-installation/re-creation of your account. Proceed with caution!

Uninstall awaBerry client from device

  • "View Uninstall Instructions" button: Click to view detailed, step-by-step instructions on how to completely remove the awaBerry client from your device.

Delete Your Account

  • "Delete My Account and Data" button: This action will permanently delete your awaBerry account and all associated data. You will be guided through a confirmation process to ensure this is your intended action.

Scenario Executions

Possible usage steps within this page

  1. Logging Out:

    Scenario: You want to securely log out of your awaBerry account.

    Steps: Locate the "Logout user" button within the "User Account Information" section and click it.

    Outcome: You will be logged out of the awaBerry application.

  2. Setting Up Two-Factor Authentication:

    Scenario: You want to enable Two-Factor Authentication for enhanced security.

    Steps: In the "Two-Factor Authentication" section, click the "Edit two factor authentication" button or toggle the switch to "Enabled." Follow the on-screen prompts to complete the setup process.

    Outcome: Two-Factor Authentication will be activated, protecting your encryption keys.

  3. Configuring Your Own Google Gemini API Key:

    Scenario: You want to use your own Google Gemini API key for unlimited intelligence features.

    Pre-requisite: Two-Factor Authentication must be enabled.

    Steps: Ensure Two-Factor Authentication is enabled. Then, in the "Google Studio API Key for Intelligence" section, click the "Setup your own Google Studio API key" button or toggle the switch. Enter your API key and follow any additional instructions.

    Outcome: Your custom Google Gemini API key will be configured, enabling unlimited intelligence routines.

  4. Configuring Your Own S3 Storage:

    Scenario: You want to use your own S3-compatible storage for file uploads.

    Pre-requisite: Two-Factor Authentication must be enabled.

    Steps: Ensure Two-Factor Authentication is enabled. Then, in the "S3 Storage Configuration" section, click the "Setup S3 Storage" button or toggle the switch. Provide your S3 storage details (provider, URL, bucket name, keys) and follow the prompts.

    Outcome: Your custom S3 storage will be configured for file uploads.

  5. Viewing Your Stored Data:

    Scenario: You want to review all data awaBerry stores for your account.

    Steps: In the "View Stored Data (GDPR)" section, click the "Open report" button.

    Outcome: You will be taken to a page displaying a report of your stored data.

  6. Accessing Support:

    Scenario: You need help, want to report an issue, or read the user manual.

    Steps: Navigate to the "awaBerry Support" section and click on the relevant link: "User Manual," "Contact Form," "Report a Bug," or "Report Abuse."

    Outcome: The chosen support resource will open in your web browser.

  7. Viewing Uninstall Instructions:

    Scenario: You need to uninstall the awaBerry client from your device.

    Steps: In the "Danger Zone" section, locate "Uninstall awaberry client from device" and click the "View Uninstall Instructions" button.

    Outcome: You will be redirected to a page providing step-by-step uninstall instructions.

  8. Initiating Account Deletion:

    Scenario: You wish to permanently delete your awaBerry account and all associated data.

    Steps: In the "Danger Zone" section, locate "Delete Your Account" and click the "Delete My Account and Data" button.

    Outcome: You will be taken to a dedicated page to confirm and proceed with account deletion. Be aware this action is irreversible.

Possible errors which may occur on this page

  1. Two-Factor Authentication Requirement for Google API Key/S3 Storage:

    Error: You try to set up your Google Gemini API key or S3 storage, but Two-Factor Authentication is disabled.

    Why this error happens: For security reasons, awaBerry requires 2FA to be active before you can securely store sensitive credentials like your Google API key or S3 access keys in the cloud. Without 2FA, your credentials cannot be adequately protected.

    How to resolve: First, navigate to the "Two-Factor Authentication" section and enable it. Once 2FA is active, you can then proceed with setting up your Google API key or S3 storage.

  2. Missing License Information:

    Error: The "Today's Usage Statistics" section is not visible, or license details appear incomplete in the "Current License & Subscription" section.

    Why this error happens: This section depends on your current awaBerry license setup and usage data being successfully fetched from the system. If there's an issue with your internet connection, a problem with the awaBerry service, or if you are using a basic 'connect' license that doesn't track these metrics, the section may not display or may show limited information.

    How to resolve: Ensure you have an active awaBerry license. Check your internet connection. If the issue persists, try restarting the application. If you continue to experience problems, contact awaBerry support.

  3. Failed to Retrieve User Email:

    Error: Your email address in the "User Account Information" section displays "User Email" instead of your actual registered email address.

    Why this error happens: This typically indicates a temporary issue with retrieving your email address from the internal system or the authentication service. It does not mean your account is invalid, just that the information could not be displayed at that moment.

    How to resolve: This is usually a temporary display issue. Try refreshing the page (if applicable) or restarting the awaBerry application. If the problem continues, and you are logged in, contact awaBerry support for assistance.