Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kroese authored Sep 24, 2024
1 parent 01c3ebd commit 9cc8f0a
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1 +1,56 @@
<h1 align="center">UmbrelOS<br />
<div align="center">
<a href="https://github.com/dockur/umbrel"><img src="https://raw.githubusercontent.com/dockur/umbrel/master/.github/logo.png" title="Logo" style="max-width:100%;" width="256" /></a>
</div>
<div align="center">

[![Build]][build_url]
[![Version]][tag_url]
[![Size]][tag_url]
[![Package]][pkg_url]
[![Pulls]][hub_url]

</div></h1>

Docker container of [UmbrelOS](https://umbrel.com/).

## Features ✨

* No dedicated hardware or virtual machine required!

## Usage 🐳

Via Docker Compose:

```yaml
services:
umbrel:
image: dockurr/umbrel
container_name: umbrel
ports:
- 80:80
volumes:
- "/var/umbrel:/data"
- "/var/run/docker.sock:/var/run/docker.sock"
stop_grace_period: 1m
```
Via Docker CLI:
```bash
docker run -it --rm -p 80:80 -v /var/run/docker.sock:/var/run/docker.sock --stop-timeout 60 dockurr/umbrel
```

## Stars 🌟
[![Stars](https://starchart.cc/dockur/umbrel.svg?variant=adaptive)](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

0 comments on commit 9cc8f0a

Please sign in to comment.