https://github.com/dockur/umbrel
umbrelOS inside a Docker container.
https://github.com/dockur/umbrel
docker docker-container home-server homeserver self-hosted selfhosting
Last synced: 6 months ago
JSON representation
umbrelOS inside a Docker container.
- Host: GitHub
- URL: https://github.com/dockur/umbrel
- Owner: dockur
- License: mit
- Created: 2024-09-23T23:15:13.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-27T00:45:39.000Z (7 months ago)
- Last Synced: 2025-03-28T16:04:20.558Z (6 months ago)
- Topics: docker, docker-container, home-server, homeserver, self-hosted, selfhosting
- Language: TypeScript
- Homepage:
- Size: 4.4 MB
- Stars: 201
- Watchers: 6
- Forks: 17
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
umbrelOS
[![Build]][build_url]
[![Version]][tag_url]
[![Size]][tag_url]
[![Package]][pkg_url]
[![Pulls]][hub_url]
Docker container of [Umbrel](https://umbrel.com/umbrelos) (an OS for self-hosting), making it possible to run it on any system instead of needing a dedicated device.
## Features ✨
* Does not need dedicated hardware or a virtual machine!
## Usage 🐳
##### Via Docker Compose:
```yaml
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
```
##### Via Docker CLI:
```bash
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 dockurr/umbrel
```
##### Via Github Codespaces:
[](https://codespaces.new/dockur/umbrel)
## Screenshot 📸
## FAQ 💬
### How do I change the storage location?
To change the storage location, include the following bind mount in your compose file:
```yaml
volumes:
- ./umbrel:/data
```
Replace the example path `./umbrel` with the desired storage folder or named volume.
## Stars 🌟
[](https://starchart.cc/dockur/umbrel)
[build_url]: https://github.com/dockur/umbrel/
[hub_url]: https://hub.docker.com/r/dockurr/umbrel
[tag_url]: https://hub.docker.com/r/dockurr/umbrel/tags
[pkg_url]: https://github.com/dockur/umbrel/pkgs/container/umbrel
[Build]: https://github.com/dockur/umbrel/actions/workflows/build.yml/badge.svg
[Size]: https://img.shields.io/docker/image-size/dockurr/umbrel/latest?color=066da5&label=size
[Pulls]: https://img.shields.io/docker/pulls/dockurr/umbrel.svg?style=flat&label=pulls&logo=docker
[Version]: https://img.shields.io/docker/v/dockurr/umbrel/latest?arch=amd64&sort=semver&color=066da5
[Package]:https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fipitio.github.io%2Fbackage%2Fdockur%2Fumbrel%2Fumbrel.json&query=%24.downloads&logo=github&style=flat&color=066da5&label=pulls