Skip to content

About

Desktop client for UmbrelOS with Electron

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

14 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VoidOS Logo Umbrel Desktop

A desktop client for connecting to your UmbrelOS server from Windows and Linux
UmbrelOS is required: umbrel.com/umbrelos »

Built with Electron, with a custom desktop shell, saved server connection, session persistence, and packaging support for Windows and Linux.


Umbrel Desktop is a standalone desktop interface for opening and using your existing UmbrelOS server without relying on a normal browser tab.

It provides a dedicated desktop experience with a custom window shell, quick server switching, optional session persistence, and packaging for native Windows and Linux distribution.

Think of it as a lightweight UmbrelOS companion app, not the server itself.


Features

  • Connect to any UmbrelOS server by IP and port
  • Custom desktop shell built with Electron
  • Session persistence for UmbrelOS login cookies
  • Dropdown controls for switching server, reset, settings, and fullscreen
  • Exportable builds for Windows and Linux

Getting started

Development

npm install
npm run dev

On first launch, the app asks for:

  • Umbrel server IP
  • Port, defaulting to 80 if left empty

It then opens your UmbrelOS instance directly inside the desktop client.

Building the app

This project supports packaging for both Windows and Linux with electron-builder.

Available build commands

  • npm run pack
  • npm run dist
  • npm run dist:win
  • npm run dist:linux

Build output

Build artifacts are generated in:

release/

Targets

  • Windows: nsis, portable
  • Linux: AppImage, deb

Settings

Umbrel Desktop currently includes:

  • Data persistence

When enabled, UmbrelOS login data is stored in cookies so the client can keep your session available for automatic login on the current device.

Project structure

src/
  main.js
  preload.js
  renderer/
assets/
scripts/

Tech stack

  • Electron
  • electron-store
  • electron-builder

Disclaimer

Umbrel Desktop is a client for connecting to umbrelOS. It does not install, provision, or run umbrelOS itself.

For installing the actual server OS, visit:

Future updates

I'm gonna rework the app and move to Tauri V2 Due to Electron being too resource expensive
If you have the same problem, shut up.
I know your PC can handle Electron. Mine can't. So, we are switching to Tauri.

About

Desktop client for UmbrelOS with Electron

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages