DOCSEARCHbyAlgolia
Submit Docs

OpenUEM Documentation

website·Indexed 32 days ago

https://openuem.eu

OpenUEM is an open-source, self-hosted, unified endpoint manager. It provides tools for endpoint inspection, remote assistance via VNC, and multi-tenancy support. The platform consists of a web-based Console, server components, and agents compatible with Windows, macOS, and Linux. Documentation covers installation via Docker, Podman, or native packages, OIDC authentication configuration, and system administration.

Tokens
30.9K
Snippets
74
Records
234
Agent score
62%

What's inside OpenUEM

  1. Overview of OpenUEM capabilities

    OpenUEM is an open-source, self-hosted Unified Endpoint Management (UEM) tool designed to maintain an inventory of IT assets via agents installed on endpoints. It functions as a hybrid of several IT management categories: IT asset inventory, Unified Endpoint Management (UEM), Remote Monitoring and Management (RMM), and Mobile Device Management (MDM).

  2. Monitor endpoint security status with OpenUEM agents

    OpenUEM agents automatically collect security status data from installed endpoints. This allows administrators to monitor the following:

    • Antivirus Status: Verify if the antivirus system is enabled and up-to-date.
    • Windows Updates: Track how updates are downloaded and installed, when updates were last searched or installed, and identify pending updates.
    • Update History: Browse the historical record of Windows updates applied to the endpoint.

  3. Understand and use the OpenUEM Dashboard

    The OpenUEM dashboard provides a high-level overview of the environment through charts and categorized status sections.

    Monitoring Charts:

    • Agent reporting status (last 24 hours).
    • Platform distribution.
    • Operating system version distribution.

    Status Sections:

    • Critical/Alerts (Red): Highlights urgent issues such as agents that haven't reported, pending updates, disabled antivirus, or available updates.
    • Environment Statistics (Green): Displays general metrics including total users, number of discovered applications, and applied tags.
    • Service Status (Blue): Shows the operational status of the various components providing the OpenUEM service.

    Interactivity:

    • Data Refresh: The dashboard refreshes automatically every 5 minutes by default, or manually via the Refresh button.
    • Navigation: Numerical values in the dashboard often act as links that navigate to specific Console sections, typically with a relevant filter already applied.

  4. Manage endpoints and agents using the OpenUEM Console

    The OpenUEM Console is the Web User Interface used to manage the OpenUEM ecosystem. It provides centralized control for agent administration, endpoint monitoring, and software deployment. Key capabilities include:

    • Agent Management: Admit, enable, or disable agents.
    • Endpoint Inspection: Browse gathered endpoint information and explore files on logical disks.
    • Remote Support: Initiate remote assistance sessions.
    • Software Deployment: Deploy or uninstall packages via Winget, Flatpak, or HomeBrew.
    • Security Monitoring: Verify agent security status, including antivirus and security updates.
    • Configuration: Create configuration profiles containing tasks for agents to execute.
    • System Health: Monitor statistics and the operational status of OpenUEM components.

  5. Install OpenUEM agents on Debian-based distributions

    OpenUEM provides agent support for Debian-based Linux distributions, including Debian, Ubuntu, and Linux Mint.

  6. OpenUEM supported platforms and operating systems

    OpenUEM is a self-hosted solution. Both Agents and Server components are supported on the following platforms:

    • Windows
    • Debian-based distributions (Debian, Ubuntu, Linux Mint)
    • RedHat-based distributions (Fedora, Alma Linux, Rocky Linux, RedHat)
    • MacOS (Agents available for both Intel and Apple Silicon)

  7. Understand OpenUEM worker types and responsibilities

    OpenUEM utilizes specialized workers to handle asynchronous tasks. There are three primary worker types:

    • Agent Worker: Processes information received from agents and persists it into the PostgreSQL database.
    • Notification Worker: Handles the delivery of email messages to users (e.g., email address confirmation, login certificate delivery) once an administrator has configured the SMTP settings.
    • Certification Manager Worker: Generates certificates on demand for both users and agents.

  8. OpenUEM Open Source License and Contribution

    OpenUEM's source code is released under the Apache 2.0 License, allowing users to contribute to the project's evolution.

  9. Manage computer inventory in OpenUEM

    The Computers' list provides an inventory of enabled computers that have contacted OpenUEM. The table displays the hostname, OS version, manufacturer, model, and associated tags. Users can navigate to a specific computer's details by clicking the hostname or using the 'view' action from the three-dots menu.

    Remote Endpoint Identification: OpenUEM uses DNS and the reported active IP address to identify endpoints outside the LAN (remote workers). These are marked with a plane icon. Note that remote file browsing, remote assistance, and Wake On Lan (WOL) are unavailable for remote endpoints.

  10. Understand NATS messaging in OpenUEM

    OpenUEM uses NATS as its messaging infrastructure to enable communication between components. NATS handles the exchange of data messages for critical system actions, including:

    • Enabling or disabling agents
    • Triggering reports on agents
    • Starting VNC proxies and managing session passwords
    • Deploying packages to endpoints
    • Creating email requests
    • Distributing configuration profiles to agents
    • Performing OpenUEM release updates for agents and servers

  11. Inspect computer hardware and system details

    The Computer's details view is organized into tabs providing the following data:

    • Overview: Security status, OS briefing, endpoint description, type (desktop, laptop, tablet), and organization/site assignment.
    • Hardware: Manufacturer, model, serial number, processor, and memory.
    • Operating System: Version, description, architecture, currently logged-in username, installation date, and last boot time.
    • Monitors: Manufacturer, model, and serial number of connected monitors.
    • Physical Disks: Device name, vendor, model, serial number, and size.
    • Shares: Resources being shared and exported by the computer.
    • Network Adapters: Name, MAC address, IP address, subnet, default gateway, DHCP status, speed, and DNS server information (via hover).
    • Printers: Name, port, default status, and network status. (From v0.7.0 with agents v0.6.0+, you can set a printer as default or remove it).
    • Software: List of installed applications (via Windows Registry or Linux package managers like apt, zypper, dnf, pacman) including version and publisher.

  12. Understand the OpenUEM system architecture

    OpenUEM uses a distributed architecture where components communicate via a NATS server. The system consists of the following core components:

    • Agents: Installed at endpoints to collect and send reports.
    • Agent Workers: Process reports received from agents and store the data in a Postgres database.
    • Console: A web interface for browsing reported information and managing tasks.
    • OCSP Responder: Validates digital certificates used within the system.
    • Cert-manager Worker: Generates new digital certificates.
    • Notification Worker: Sends email notifications to users via SMTP.
    • Postgres Database: Central storage for agent information.
    • NATS Server: The messaging backbone that enables communication between all components.

    These components can be deployed on a single machine or distributed across multiple computers.