A beautiful personal server OS for Raspberry Pi or any Linux distro for running self-hosted apps
Go to file
Luke Childs 7103e98909
Fix umbrel-dev for multipass 1.14
Multipass dropped support for Ubuntu 23.10 base images which we had
pinned to so the latest version of Multipass gave errors when trying to
provision a VM saying that Ubuntu version didn't exist.

After changing to the latest LTS 24.04 a VM could be created but the
provision script failed to execute with a permission error. It looks
like the way mounts work has totally changed in this version of
Multipass because now all mounts are unable to be read inside the VM.
You can't even fix it with permissions, even root cannot read the files
and you can't chown/chmod etc.

Multipass has another mount type called `native`
(https://multipass.run/docs/mount#native-mounts) which works for me on
Mac, however you can't specify this mount type at VM creation and also
can't create this mount type while the VM is running. So we now, create
the VM, wait for it to boot, then stop it, then setup the native mount,
then start it again, then run the provision script.

The provision script then fails because the version of Docker we use
(25.0.4) does not exist in the Ubuntu 24.04 repos because that Ubuntu
version came out after that Docker version. This was fixed by rolling
the Ubuntu version back to the previous LTS version 22.04.

This is now working for but since we've changed Ubuntu versions every
single package on the system will now be a different version to what
we've tested before. Also the native mount type acts differently on
different systems and doesn't always work if the native platform doesn't
support it. It's unclear how well this will work on other platforms but
it appears to work well for me on arm macOS.
2024-08-14 18:09:36 +01:00
.github/workflows Automatically generate, remove and sort translations 2024-06-17 18:11:48 +07:00
containers Fix app-auth builds and rebuild public images 2024-04-16 23:32:36 +07:00
packages umbrelOS 1.2.2 2024-07-29 19:54:30 +01:00
scripts umbrelOS 1.2.2 2024-07-29 19:54:30 +01:00
.gitignore Fix broken packages due to invalid gitignore 2024-03-07 15:37:41 +07:00
.umbrel Implement 0.5.x OTA update shim 2024-03-18 02:42:44 +07:00
CONTRIBUTING.md Switch to the PolyForm Noncommercial license (#908) 2021-08-14 14:08:49 +05:30
info.json Add release notes 2024-03-18 23:21:40 +07:00
LICENSE.md Switch to the PolyForm Noncommercial license (#908) 2021-08-14 14:08:49 +05:30
package-lock.json Cleanup CI 2023-06-30 22:52:10 +07:00
package.json Fix umbrel-dev for multipass 1.14 2024-08-14 18:09:36 +01:00
README.md Update README.md with x86 installation links 2024-04-30 05:28:40 +07:00

umbrelOS

umbrelOS

A beautiful home server OS for self-hosting
umbrel.com »

Buy an Umbrel Home or install on:
Raspberry Pi 4 · Raspberry Pi 5 · Any x86 system


Watch the umbrelOS 1.0 reveal


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 personal 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

Umbrel App Store


Here are some of the apps available in the Umbrel App Store. For the complete list of apps, visit apps.umbrel.com.

Bitcoin & Finance

  • Bitcoin Node — Run your personal node powered by Bitcoin Core
  • Electrs — A simple and efficient Electrum Server
  • Mempool — A self-hosted explorer for the Bitcoin community
  • Bitfeed — A beautiful mempool visualizer and block explorer
  • BTCPay Server — Accept Bitcoin payments with zero fees & no 3rd party
  • RoboSats — Simple and Private Bitcoin P2P Exchange
  • Jam — Your sats. Your privacy. Your profit.
  • Samourai Server — Your private backing server for Samourai Wallet
  • Lightning Node — Run your personal Lightning Network node
  • Core Lightning — Run your personal Core Lightning node
  • Lightning Terminal — The easiest way to manage channel liquidity
  • LNBits — Multi-user wallet management system
  • Ride The Lightning — A powerful dashboard for the Lightning Network
  • ThunderHub — Take full control of your Lightning node
  • Invoice Ninja - We'll help with the invoicing

AI

  • LlamaGPT - Self-hosted, offline ChatGPT-like chatbot powered by Llama 2
  • ChatBot UI - ChatGPT but better
  • Chatpad AI - Premium quality UI for ChatGPT

Files & Productivity

  • Calibre Web — A clean web app for your eBooks
  • Nextcloud — Productivity platform that keeps you in control
  • Immich - High performance photo and video backup solution
  • PhotoPrism — Self-host your photo and video library
  • SyncThing — Peer-to-peer file synchronization between your devices
  • Vaultwarden — Unofficial Bitwarden® compatible server

Media

  • Jellyfin — The Free Software Media System
  • Lidarr — Looks and smells like Sonarr but made for music
  • Plex — Stream Movies & TV Shows
  • Prowlarr — Indexer manager/proxy for Sonarr, Radarr, and Lidarr
  • Radarr — Your movie collection manager
  • Sonarr — Smart PVR for newsgroup and bittorrent users

Networking

  • Pi-hole — Block ads on your entire network
  • Tailscale — Zero config VPN to access your Umbrel from anywhere
  • Transmission — A fast, easy and free BitTorrent client
  • Uptime Kuma — Self-hosted uptime monitoring tool
  • Urbit — Run Urbit on your Umbrel
  • Whoogle Search — A self-hosted, ad-free, privacy-respecting metasearch engine

Social

  • Element — A glossy Matrix client compatible with Synapse
  • Invidious — Browse YouTube without tracking or ads
  • LibReddit — An alternative private front-end to Reddit
  • Nitter — Browse Twitter without tracking or ads
  • Nostr Relay - Backup all your Nostr activity with your private relay
  • Synapse — Matrix reference homeserver

Automation

  • Home Assistant — Home automation that puts local control & privacy first
  • n8n - Build complex workflows, really fast
  • Node-RED — Wire together the Internet of Things

Developer Tools

  • Code Server — Run VS Code on your Umbrel
  • Gitea — A painless self-hosted Git service

If an app you're looking for isn't available on our app store yet, feel free to open an issue on the umbrel-apps respository to request it.

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.

Setting up a development environment

With the release of umbrelOS 1.0, a lot of the underlying architecture of the project has changed. This section will be re-written with up-to-date development instructions.

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