Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
219 changes: 190 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,35 @@
[![umbrelOS](https://github.com/getumbrel/umbrel/assets/10330103/56be7b95-0c24-4dee-ad3a-e5947bc2ee07)](https://umbrel.com/umbrelos)

[English](#english) | [Português](#português)

---

## English <a name="english"></a>

<p align="center">
<h1 align="center">umbrelOS</h1>
<p align="center">
A beautiful home server OS for self-hosting
<br />
<a href="https://umbrel.com"><strong>umbrel.com »</strong></a>
<br />
<br />
Get an <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.
<br />
<br />
<a href="https://twitter.com/umbrel">
<img src="https://img.shields.io/twitter/follow/umbrel?style=social" />
</a>
<a href="https://t.me/getumbrel">
<img src="https://img.shields.io/badge/community-chat-%235351FB">
</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.getumbrel.com">
<img src="https://img.shields.io/badge/community-forum-%235351FB">
</a>
</p>
  <h1 align="center">umbrelOS</h1>
  <p align="center">
    A beautiful home server OS for self-hosting
    <br />
    <a href="https://umbrel.com"><strong>umbrel.com »</strong></a>
    <br />
    <br />
       Get an <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.
    <br />
    <br />
    <a href="https://twitter.com/umbrel">
      <img src="https://img.shields.io/twitter/follow/umbrel?style=social" />
    </a>
    <a href="https://t.me/getumbrel">
      <img src="https://img.shields.io/badge/community-chat-%235351FB">
    </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.getumbrel.com">
      <img src="https://img.shields.io/badge/community-forum-%235351FB">
    </a>
  </p>
</p>

<br />
Expand All @@ -44,19 +50,19 @@ Just like the cloud, but one that you own and control.

<br />

## Installing umbrelOS
### Installing umbrelOS

umbrelOS is designed for the [Umbrel Home](https://umbrel.com/umbrel-home), where it includes all features like external storage support and Migration Assistant. 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](https://github.com/getumbrel/umbrel/wiki/umbrelOS-on-Umbrel-Home-vs.-DIY).

### Installation guides
#### Installation guides
- [Install umbrelOS on a Raspberry Pi 5](https://github.com/getumbrel/umbrel/wiki/Install-umbrelOS-on-a-Raspberry-Pi-5)
- [Install umbrelOS on any x86 system](https://github.com/getumbrel/umbrel/wiki/Install-umbrelOS-on-x86-Systems)
- [Install umbrelOS in a VM](https://github.com/getumbrel/umbrel/wiki/Install-umbrelOS-on-a-Linux-VM)


## Umbrel App Store
### 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](https://apps.umbrel.com/).

Expand Down Expand Up @@ -134,18 +140,173 @@ Here are some of the apps available in the Umbrel App Store. For the complete li
> [!TIP]
> 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](https://github.com/getumbrel/umbrel-apps) respository to request it.

## Building apps for 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](https://github.com/getumbrel/umbrel-apps/blob/master/README.md).

## Setting up a development environment
### 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
### 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 [email protected].

[![License](https://img.shields.io/badge/license-PolyForm%20Noncommercial%201.0.0-%235351FB)](https://github.com/getumbrel/umbrel/blob/master/LICENSE.md)

[umbrel.com](https://umbrel.com)

---
---

## Português <a name="português"></a>

<p align="center">
  <h1 align="center">umbrelOS</h1>
  <p align="center">
    Um belo sistema operacional de servidor doméstico para auto-hospedagem
    <br />
    <a href="https://umbrel.com"><strong>umbrel.com »</strong></a>
    <br />
    <br />
       Adquira um <a href="https://umbrel.com/umbrel-home">Umbrel Home</a> para a experiência completa, ou instale o umbrelOS gratuitamente em um <a href="https://github.com/getumbrel/umbrel/wiki/Install-umbrelOS-on-a-Raspberry-Pi-5">Raspberry Pi 5</a> ou em <a href="https://github.com/getumbrel/umbrel/wiki/Install-umbrelOS-on-x86-systems">qualquer sistema x86</a>.
    <br />
    <br />
    <a href="https://twitter.com/umbrel">
      <img src="https://img.shields.io/twitter/follow/umbrel?style=social" />
    </a>
    <a href="https://t.me/getumbrel">
      <img src="https://img.shields.io/badge/community-chat-%235351FB">
    </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.getumbrel.com">
      <img src="https://img.shields.io/badge/community-forum-%235351FB">
    </a>
  </p>
</p>

<br />

<p align="center">
No Umbrel, acreditamos que todos deveriam poder desfrutar da conveniência e dos benefícios da nuvem, sem abrir mão da propriedade e do controle de seus dados.
</p>

<p align="center">
Para alcançar nossa visão, estamos construindo um novo tipo de sistema operacional para servidores domésticos. Em vez de pagar resgates para armazenar seus dados no computador de outra pessoa enquanto eles os leiloam para anunciantes, agora você pode facilmente ativar um servidor e auto-hospedar seus dados e serviços em casa.
</p>

<p align="center">
Assim como a nuvem, mas uma que você possui e controla.
</p>

<br />

<br />

### Instalando o umbrelOS

O umbrelOS foi projetado para o [Umbrel Home](https://umbrel.com/umbrel-home), onde inclui todos os recursos, como suporte a armazenamento externo e o Assistente de Migração. Em outros dispositivos (como Raspberry Pi ou sistemas x86), ele está disponível gratuitamente com funcionalidades essenciais, mas o suporte e a disponibilidade de recursos são fornecidos no modelo "best-effort" (na medida do possível) devido às diferenças de hardware.

Para uma análise detalhada dos recursos, consulte nosso [guia de comparação](https://github.com/getumbrel/umbrel/wiki/umbrelOS-on-Umbrel-Home-vs.-DIY).

#### Guias de instalação
- [Instalar o umbrelOS em um Raspberry Pi 5](https://github.com/getumbrel/umbrel/wiki/Install-umbrelOS-on-a-Raspberry-Pi-5)
- [Instalar o umbrelOS em qualquer sistema x86](https://github.com/getumbrel/umbrel/wiki/Install-umbrelOS-on-x86-Systems)
- [Instalar o umbrelOS em uma VM](https://github.com/getumbrel/umbrel/wiki/Install-umbrelOS-on-a-Linux-VM)


### Loja de Aplicativos Umbrel

Aqui estão alguns dos aplicativos disponíveis na Loja de Aplicativos Umbrel. Para a lista completa, visite [apps.umbrel.com](https://apps.umbrel.com/).

#### Arquivos e Produtividade

- [Calibre Web](https://apps.umbrel.com/app/calibre-web) — Um aplicativo web elegante para seus eBooks
- [Nextcloud](https://apps.umbrel.com/app/nextcloud) — Plataforma de produtividade que mantém você no controle
- [Immich](https://apps.umbrel.com/app/immich) - Solução de backup de fotos e vídeos de alto desempenho
- [PhotoPrism](https://apps.umbrel.com/app/photoprism) — Auto-hospede sua biblioteca de fotos e vídeos
- [SyncThing](https://apps.umbrel.com/app/syncthing) — Sincronização de arquivos ponto a ponto entre seus dispositivos
- [Vaultwarden](https://apps.umbrel.com/app/vaultwarden) — Servidor não oficial compatível com Bitwarden®

#### Mídia

- [Jellyfin](https://apps.umbrel.com/app/jellyfin) — O Sistema de Mídia de Software Livre
- [Lidarr](https://apps.umbrel.com/app/lidarr) — Parece e cheira como o Sonarr, mas feito para música
- [Plex](https://apps.umbrel.com/app/plex) — Transmita Filmes e Séries de TV
- [Prowlarr](https://apps.umbrel.com/app/prowlarr) — Gerenciador/proxy de indexadores para Sonarr, Radarr e Lidarr
- [Radarr](https://apps.umbrel.com/app/radarr) — Seu gerenciador de coleção de filmes
- [Sonarr](https://apps.umbrel.com/app/sonarr) — PVR inteligente para usuários de newsgroups e bittorrent

#### Bitcoin e Finanças

- [Bitcoin Node](https://apps.umbrel.com/app/bitcoin) — Execute seu nó pessoal com o poder do Bitcoin Core
- [Electrs](https://apps.umbrel.com/app/electrs) — Um Servidor Electrum simples e eficiente
- [Mempool](https://apps.umbrel.com/app/mempool) — Um explorador auto-hospedado para a comunidade Bitcoin
- [Bitfeed](https://apps.umbrel.com/app/bitfeed) — Um belo visualizador de mempool e explorador de blocos
- [BTCPay Server](https://apps.umbrel.com/app/btcpay-server) — Aceite pagamentos em Bitcoin com zero taxas e sem terceiros
- [RoboSats](https://apps.umbrel.com/app/robosats) — Exchange P2P de Bitcoin simples e privada
- [Jam](https://apps.umbrel.com/app/jam) — Seus sats. Sua privacidade. Seu lucro.
- [Samourai Server](https://apps.umbrel.com/app/samourai-server) — Seu servidor de suporte privado para a Carteira Samourai
- [Lightning Node](https://apps.umbrel.com/app/lightning) — Execute seu nó pessoal da Lightning Network
- [Core Lightning](https://apps.umbrel.com/app/core-lightning) — Execute seu nó pessoal Core Lightning
- [Lightning Terminal](https://apps.umbrel.com/app/lightning-terminal) — A maneira mais fácil de gerenciar a liquidez dos canais
- [LNBits](https://apps.umbrel.com/app/lnbits) — Sistema de gerenciamento de carteiras multiusuário
- [Ride The Lightning](https://apps.umbrel.com/app/ride-the-lightning) — Um painel poderoso para a Lightning Network
- [ThunderHub](https://apps.umbrel.com/app/thunderhub) — Assuma o controle total do seu nó Lightning
- [Invoice Ninja](https://apps.umbrel.com/app/invoice-ninja) - Nós ajudamos com o faturamento

#### IA

- [LlamaGPT](https://apps.umbrel.com/app/llama-gpt) - Chatbot auto-hospedado e offline semelhante ao ChatGPT, baseado no Llama 2
- [ChatBot UI](https://apps.umbrel.com/app/chatbot-ui) - ChatGPT, só que melhor
- [Chatpad AI](https://apps.umbrel.com/app/chatpad-ai) - UI de qualidade premium para o ChatGPT

#### Redes

- [Pi-hole](https://apps.umbrel.com/app/pi-hole) — Bloqueie anúncios em toda a sua rede
- [Tailscale](https://apps.umbrel.com/app/tailscale) — VPN de configuração zero para acessar seu Umbrel de qualquer lugar
- [Transmission](https://apps.umbrel.com/app/transmission) — Um cliente BitTorrent rápido, fácil e gratuito
- [Uptime Kuma](https://apps.umbrel.com/app/uptime-kuma) — Ferramenta de monitoramento de tempo de atividade auto-hospedada
- [Urbit](https://apps.umbrel.com/app/urbit) — Execute o Urbit no seu Umbrel
- [Whoogle Search](https://apps.umbrel.com/app/whoogle-search) — Um metamotor de busca auto-hospedado, sem anúncios e que respeita a privacidade

#### Social

- [Element](https://apps.umbrel.com/app/element) — Um cliente Matrix elegante compatível com Synapse
- [Invidious](https://apps.umbrel.com/app/invidious) — Navegue no YouTube sem rastreamento ou anúncios
- [LibReddit](https://apps.umbrel.com/app/libreddit) — Uma interface alternativa e privada para o Reddit
- [Nitter](https://apps.umbrel.com/app/nitter) — Navegue no Twitter sem rastreamento ou anúncios
- [Nostr Relay](https://apps.umbrel.com/app/nostr-relay) - Faça backup de toda a sua atividade Nostr com seu relay privado
- [Synapse](https://apps.umbrel.com/app/synapse) — Servidor de referência Matrix

#### Automação

- [Home Assistant](https://apps.umbrel.com/app/home-assistant) — Automação residencial que prioriza o controle local e a privacidade
- [n8n](https://apps.umbrel.com/app/n8n) - Crie fluxos de trabalho complexos, de forma muito rápida
- [Node-RED](https://apps.umbrel.com/app/node-red-standalone) — Conecte a Internet das Coisas

#### Ferramentas de Desenvolvedor

- [Code Server](https://apps.umbrel.com/app/code-server) — Execute o VS Code no seu Umbrel
- [Gitea](https://apps.umbrel.com/app/gitea) — Um serviço Git auto-hospedado e sem complicações

> [!TIP]
> Se um aplicativo que você procura ainda não estiver disponível em nossa loja de aplicativos, sinta-se à vontade para abrir uma issue no repositório [umbrel-apps](https://github.com/getumbrel/umbrel-apps) para solicitá-lo.

### Criando aplicativos para o umbrelOS

Se você estiver interessado em criar um aplicativo para o umbrelOS ou empacotar um já existente, consulte a [documentação do Umbrel App Framework](https://github.com/getumbrel/umbrel-apps/blob/master/README.md).

### Configurando um ambiente de desenvolvimento

Com o lançamento do umbrelOS 1.0, grande parte da arquitetura subjacente do projeto mudou. Esta seção será reescrita com instruções de desenvolvimento atualizadas.

### Licença

O umbrelOS está licenciado sob a licença PolyForm Noncommercial 1.0.0. Em resumo — Você é livre para usar, fazer fork, modificar e redistribuir o Umbrel para uso pessoal e sem fins lucrativos sob a mesma licença. Se você estiver interessado em usar o umbrelOS para fins comerciais, como vender servidores domésticos plug-and-play com o umbrelOS, etc — entre em contato conosco em [email protected].

[![License](https://img.shields.io/badge/license-PolyForm%20Noncommercial%201.0.0-%235351FB)](https://github.com/getumbrel/umbrel/blob/master/LICENSE.md)

[umbrel.com](https://umbrel.com)