Skip to content

README.md

Latest commit

 

History

History
65 lines (45 loc) · 2.46 KB

README.md

File metadata and controls

65 lines (45 loc) · 2.46 KB
Raw

miniweed — Umbrel Community App Store

A community Umbrel app store. It currently ships two apps:

Tunnel

Expose your Umbrel services to the internet through your own VPS — no router port forwarding, works behind CGNAT.

A 100% self-hosted alternative to Cloudflare Tunnel. Inbound traffic enters through a small VPS you control and travels an encrypted WireGuard tunnel to your Umbrel; Caddy terminates HTTPS with automatic Let's Encrypt certificates.

  • 🔒 End-to-end encryption (WireGuard) — your home router never opens a port
  • 🌐 Automatic HTTPS via Caddy + Let's Encrypt
  • 🛠️ One-command VPS setup script (firewall with rollback, SSH hardening, optional CrowdSec)
  • ✅ Every generated script shows a SHA-256 you can verify before running it
  • 🔑 Panel protected by Umbrel's authenticated app proxy

See miniweed-tunnel/README.md for the full setup guide (renting a VPS, DNS records, hardening).

Notiann

Notion-style pages stored as pure markdown, shareable with live-updating public links.

A minimalist self-hosted notes app. Create pages with a visual block editor (/ menu) that stores pure markdown, organize them into folders, and share any page with a public read-only link.

  • ✍️ WYSIWYG markdown editor (Milkdown Crepe)
  • 🔗 Shareable read-only links with editable slugs (/s/my-page)
  • ⚡ Viewers see your edits live (Server-Sent Events), no reload
  • 🔑 Optional per-page password (scrypt + signed cookies)
  • 🗂 Folders to organize pages
  • 🛡 Editor protected by Umbrel's authenticated app proxy; only pages you share are public

Source: miniweed/notiann. Pairs well with Tunnel to expose your shared links on your own domain.

Add this store to Umbrel

  1. Open the App Store in your umbrelOS.

  2. Click the ⋯ menu (top right) → Community App Stores.

  3. Add the store URL:

    https://github.com/miniweed/umbrel-app-store

  4. Install Tunnel from the store.

Community app stores are installed at your own risk. Review the source before installing.

Repository layout

Path Purpose
umbrel-app-store.yml Community store manifest
miniweed-tunnel/ The Tunnel app (manifest, compose, web UI, WireGuard client, VPS scripts)
miniweed-tunnel/web/ Node/Express backend + Preact UI
miniweed-tunnel/docs/ Documentation and Umbrel submission pack

License

MIT