umbrelOS

Docker container of Umbrel, an OS for self-hosting.

Features ✨

• Runs UmbrelOS inside a Docker container
• Does not need dedicated hardware or a virtual machine
• Provides access to the Umbrel web interface
• Supports installing and running Umbrel apps
• Uses the host Docker daemon for app containers

Usage 🐳

Docker Compose:

services:
  umbrel:
    image: dockurr/umbrel
    container_name: umbrel
    pid: host
    ports:
      - 80:80
    volumes:
      - ./umbrel:/data
      - /var/run/docker.sock:/var/run/docker.sock
    restart: always
    stop_grace_period: 1m

Docker CLI:

docker run -it --rm --name umbrel --pid=host -p 80:80 -v "${PWD:-.}/umbrel:/data" -v "/var/run/docker.sock:/var/run/docker.sock" --stop-timeout 60 docker.io/dockurr/umbrel

GitHub Codespaces:

Screenshot 📸

FAQ 💬

How do I change the storage location?

To change the storage location, include the following bind mount in your compose file:

volumes:
  - ./umbrel:/data

Replace the example path ./umbrel with the desired storage folder or named volume.

How do I run CasaOS in a container?

See dockur/casa for a CasaOS container.

How do I run ZimaOS in a container?

See dockur/zima for a ZimaOS container.

Stars 🌟