# Local WEKA Home overview

In scenarios where a customer lacks connectivity to the public instance of WEKA Home, such as when the WEKA cluster is deployed in a dark site or VPC, WEKA offers the option to deploy a Local WEKA Home. This is a private instance of WEKA Home, hosted on a management server or VM, designed to meet your specific needs.

## **Key functions of Local WEKA Home**

The Local WEKA Home serves the following key functions:

* **Event management:** It receives events from the WEKA cluster, stores them locally, and allows event querying and filtering.
* **Multi-cluster monitoring:** It allows you to monitor multiple clusters within your organization.
* **Cluster overview:** The Local WEKA Home displays a comprehensive overview of your clusters and allows you to drill down into cluster telemetry data.
* **Alerting:** It triggers specific alerts based on predefined rules and supports integrated delivery methods, including Email (SMTP), SNMP, and PagerDuty.
* **Diagnostics support:** The Local WEKA Home receives support files (diagnostics) from the WEKA cluster, stores them, and makes them accessible for remote viewing by the Customer Success Team.
* **Usage and performance insights:** It receives usage, analytics, and performance statistics from the WEKA cluster, stores, displays, and enables querying and filtering this data.

## **Key features and capabilities**

Local WEKA Home offers the following features and capabilities, categorized as follows:

#### **Monitoring and insight features**

* **Cluster Insights:** Monitor and report on multiple clusters within your organization.
* **Statistics:** Display various cluster-wide statistics and health status information.
* **Event Data:** Access offline event data and associated details.
* **Diagnostics:** Access diagnostics, including event logs, syslog files, trace files, and container information.
* **Usage reports:** Download JSON-formatted Usage Reports and Analytics for analysis and support, including anonymized versions for data security.

#### **Alerting and integrations**

* **Custom rules:** Create custom rules for specific events and alerts and route them to predefined integrations.
* **Custom integrations:** Create destinations where you want alerts and events defined in the Rules page to be sent. These can be Email, PagerDuty, and SNMP Traps.

**Security and compliance controls**

* **Audit information:** View a list of audited activities.
* **Admin privileges:** Apply admin privileges for cluster management and maintenance.
* **User management:** Manage users, groups, and access permissions.

#### **Supportability and data management**

* **Data forwarding:** Forward data from the Local WEKA Home to the cloud WEKA Home for enhanced support and monitoring by the Customer Success Team.
* **REST API:** Use the RESTful API for automation and integration with your workflows and monitoring systems.

<figure><img src="https://content.gitbook.com/content/VJsIYq2tJgf6IfttPZ6j/blobs/Zt4f8m4WUGPx44lWuTfu/LWH_overview.gif" alt=""><figcaption><p>Local WEKA Home application overview</p></figcaption></figure>

## Sign in to Local WEKA Home

Authentication methods:

* Local users
* GitHub SSO

<figure><img src="https://1612658718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVJsIYq2tJgf6IfttPZ6j%2Fuploads%2FsuPl9m5NNUOs8vlcjVen%2FLWH_sign-in.png?alt=media&#x26;token=cffc1627-55c8-428b-bb6d-54bdb3800558" alt="" width="563"><figcaption><p>Sign-in to Local WEKA Home</p></figcaption></figure>

### Local user sign-in flow

1. Initiate sign-in
   * Enter email and password
   * Click **Login**
2. User validation
   * Check email and password in internal LWH database
   * Existing user: Direct sign-in
   * Non-existent user: Return `401` error
3. Access granted
   * Successful authentication
   * Enter application

### GitHub SSO sign-in flow

GitHub SSO provides secure, streamlined authentication by:

* Centralizing user access management
* Simplifying login process
* Enforcing organizational access controls
* Reducing manual user provisioning

Sign-in steps:

1. Initiate sign-in
   * Click **Sign in with GitHub**
   * Redirect to GitHub authentication
2. GitHub authentication
   * Grant access
   * Retrieve public email
   * No public email: Return `400` error
3. User validation
   * Check email in internal LWH database
   * Existing user: Direct sign-in
   * New user:
     * Validate email domain matches `emailDomain`
     * Matching domain: Auto-create account
     * Non-matching domain: Return `401` error
4. Access granted
   * Successful authentication
   * Enter application

**Related topics**

[local-weka-home-deployment](https://docs.weka.io/4.4/monitor-the-weka-cluster/the-wekaio-support-cloud/local-weka-home-deployment "mention")

[explore-cluster-insights-and-statistics](https://docs.weka.io/4.4/monitor-the-weka-cluster/the-wekaio-support-cloud/explore-cluster-insights-and-statistics "mention")

[manage-alerts-and-integrations](https://docs.weka.io/4.4/monitor-the-weka-cluster/the-wekaio-support-cloud/manage-alerts-and-integrations "mention")

[enforce-security-and-compliance](https://docs.weka.io/4.4/monitor-the-weka-cluster/the-wekaio-support-cloud/enforce-security-and-compliance "mention")

[optimize-support-and-data-management](https://docs.weka.io/4.4/monitor-the-weka-cluster/the-wekaio-support-cloud/optimize-support-and-data-management "mention")