MCPcopy Index your code
hub / github.com/getumbrel/umbrel

github.com/getumbrel/umbrel @1.7.3

Chat with this repo
repository ↗ · DeepWiki ↗ · release 1.7.3 ↗ · + Follow
2,233 symbols 7,142 edges 738 files 14 documented · 1% updated 55d ago1.7.3 · 2026-05-12★ 11,584370 open issues
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

umbrelOS

umbrelOS

A beautiful home server OS for self-hosting



<a href="https://umbrel.com"><strong>umbrel.com »</strong></a>






   Get an <a href="https://umbrel.com/umbrel-pro">Umbrel Pro</a> or <a href="https://umbrel.com/umbrel-home">Umbrel Home</a> for the full experience, or install umbrelOS on a <a href="https://github.com/getumbrel/umbrel/wiki/Install-umbrelOS-on-a-Raspberry-Pi-5">Raspberry Pi 5</a> or <a href="https://github.com/getumbrel/umbrel/wiki/Install-umbrelOS-on-x86-systems">any x86 system</a> for free.






<a href="https://x.com/umbrel">
  <img src="https://img.shields.io/twitter/follow/umbrel?style=social" />
</a>
<a href="https://discord.gg/efNtFzqtdx">
  <img src="https://img.shields.io/discord/936694604231766046?logo=discord&logoColor=5351FB&label=Discord&labelColor=white&color=5351FB&cacheSeconds=60">
</a>
<a href="https://reddit.com/r/getumbrel">
  <img src="https://img.shields.io/reddit/subreddit-subscribers/getumbrel?style=social">
</a>
<a href="https://community.umbrel.com">
  <img src="https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.umbrel.com&style=flat&label=Community%20Forum&color=5351FB&cacheSeconds=60">
</a>

At Umbrel, we believe that everyone should be able to enjoy the convenience and benefits of the cloud, without giving up ownership and control of their data.

To achieve our vision, we're building a new kind of a home server OS. Instead of paying ransoms for storing your data on someone else's computer while they auction it off to advertisers — you can now easily spin up a server and self-host your data and services at home.

Just like the cloud, but one that you own and control.

Installing umbrelOS

umbrelOS is designed for the Umbrel Pro and Umbrel Home, where it includes first-class support for all features. On other devices (like Raspberry Pi or x86 systems), it’s freely available with core functionality, but support and feature availability are best-effort due to hardware differences.

For a detailed feature breakdown, see our comparison guide.

Installation guides

umbrelOS use cases Umbrel App Store Files on umbrelOS umbrelOS Features Backups in umbrelOS External Storage & NAS in umbrelOS

Building apps for umbrelOS

If you're interested in building an app for umbrelOS or packaging an existing one, please refer to the Umbrel App Framework documentation.

License

umbrelOS is licensed under the PolyForm Noncommercial 1.0.0 license. TL;DR — You're free to use, fork, modify, and redistribute Umbrel for personal and nonprofit use under the same license. If you're interested in using umbrelOS for commercial purposes, such as selling plug-and-play home servers with umbrelOS, etc — please reach out to us at partner@umbrel.com.

License

umbrel.com

Extension points exported contracts — how you extend this code

IndexRange (Interface)
* Common index range used for virtualized rendering * - visibleStartIndex/visibleStopIndex: The first/last item indexes
packages/ui/src/features/files/components/listing/virtualized-list.tsx
InfiniteLoaderRenderProps (Interface)
* Props provided by InfiniteLoader to its render function * - onItemsRendered: Callback to notify which items are curre
packages/ui/src/features/files/components/listing/virtualized-list.tsx
GridVisibleIndices (Interface)
* Position information provided by Grid's onItemsRendered callback * Used to calculate which rows and columns are curre
packages/ui/src/features/files/components/listing/virtualized-list.tsx
GridItemData (Interface)
* Data passed to grid cells for rendering items * Contains both the item array and layout dimensions
packages/ui/src/features/files/components/listing/virtualized-list.tsx
IslandProps (Interface)
(no doc)
packages/ui/src/modules/floating-island/bare-island.tsx

Core symbols most depended-on inside this repo

cn
called by 355
packages/ui/src/lib/utils.ts
get
called by 131
packages/umbreld/source/modules/user/user.ts
set
called by 112
packages/umbreld/source/modules/utilities/file-store.ts
tw
called by 105
packages/ui/src/utils/tw.ts
useNavigate
called by 74
packages/ui/src/features/files/hooks/use-navigate.ts
get
called by 67
packages/umbreld/source/modules/files/recents.ts
createTestVm
called by 43
packages/umbreld/source/modules/test-utilities/create-test-umbreld.ts
delete
called by 41
packages/umbreld/source/modules/files/files.ts

Shape

Function 1,709
Method 367
Interface 85
Class 66
Enum 6

Languages

TypeScript100%

Modules by API surface

packages/umbreld/source/modules/system/system.ts45 symbols
packages/umbreld/source/modules/hardware/raid.ts42 symbols
packages/umbreld/source/modules/files/files.ts35 symbols
packages/umbreld/source/modules/apps/app.ts34 symbols
packages/umbreld/source/modules/backups/backups.ts32 symbols
packages/umbreld/source/modules/test-utilities/create-test-umbreld.ts27 symbols
packages/ui/src/routes/settings/advanced-network.tsx27 symbols
packages/umbreld/source/modules/hardware/umbrel-pro.ts26 symbols
packages/umbreld/source/modules/user/user.ts20 symbols
packages/umbreld/source/modules/files/external-storage.ts20 symbols
packages/umbreld/source/modules/apps/apps.ts20 symbols
packages/ui/src/features/files/hooks/use-files-operations.ts20 symbols

Dependencies from manifests, versioned

@codemirror/lang-css6.3.1 · 1×
@codemirror/lang-html6.4.11 · 1×
@codemirror/lang-javascript6.2.5 · 1×
@codemirror/lang-json6.0.2 · 1×
@codemirror/lang-markdown6.5.0 · 1×
@codemirror/lang-python6.2.1 · 1×
@codemirror/lang-xml6.1.0 · 1×
@codemirror/lang-yaml6.1.3 · 1×
@codemirror/lint6.9.5 · 1×
@codemirror/search6.6.0 · 1×
@dnd-kit/core6.3.1 · 1×
@dnd-kit/modifiers9.0.0 · 1×

Datastores touched

(mysql)Database · 1 repos

For agents

$ claude mcp add umbrel \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact