Brum

[!WARNING] Network Security & Exposure Disclaimer Brum is designed and intended to run on local workstations, homelabs, and private overlay networks (such as Tailscale, NetBird, or WireGuard).

Never expose Brum directly to the public internet. As a comprehensive administrative environment featuring host filesystem management, integrated terminal PTY execution, and power tools, exposing Brum directly without a trusted VPN or authenticated overlay network introduces significant attack surface. If remote access is necessary, always access Brum through a private overlay mesh or an authenticated VPN. See the Reverse Proxy & Mesh VPN Guide for recommended deployment topologies.

Why Brum?

Brum is a fast, multi-pane file management environment built in Rust. It combines the keyboard precision and speed of classic orthodox file managers with a modern web and desktop workspace:

• Side-by-Side Multi-Pane Browsing: Work across 1 to 4 customizable panels (Alt+1–4) simultaneously. Move, copy, and compare files effortlessly using orthodox keyboard shortcuts (F1–F10), drag-and-drop, or touch controls.
• Built-in Power Tools Suite: Everything you need is integrated directly into the workspace—no extra software required. Edit PDFs, inspect disk usage, batch rename files, play audio and video, view logs in real time, compare diffs, split large files, and launch a persistent terminal.
• Unified Local & Remote Storage: Browse local disks, USB drives, and remote infrastructure in the same view. Connect directly to SFTP/SSH, SMB/Windows shares, WebDAV, S3 buckets, and NFS without mounting external filesystems.
• Direct File Sharing: Create password-protected public share links with expiration rules and client upload dropzones straight from your browser—no third-party cloud subscription required.
• Encrypted Virtual Vaults: Secure sensitive personal or corporate files inside encrypted vault containers that stream directly through RAM, ensuring unencrypted files never touch disk.
• Multi-Node Fleet Management: Connect and monitor multiple Brum servers across your home lab, office network, or cloud VPS from a single unified web dashboard.
• Lightweight & Runs Anywhere: Deploy as a standalone desktop app on Linux and Windows, self-host with Docker on a server or NAS, or run headless as a background system service with minimal resource usage.

Quick Start

Docker

docker run -d \
  --name brum \
  -p 3140:3140 \
  -v ./data:/data \
  -v /home:/mnt/home:rw \
  --restart unless-stopped \
  ghcr.io/woofson/brum:latest

Arch Linux / CachyOS (AUR)

yay -S brum        # or: paru -S brum

Cargo / Local Build

cargo run --release        # Open http://localhost:3140 in your browser

[!NOTE] Administrative Credentials & Initial Setup: On first run with an uninitialized database, Brum dynamically generates a high-entropy random 20-character password for the admin account and outputs it to the server console (as well as docker logs brum or the logging directory).

• Desktop & Standalone: Standalone desktop mode (brum / brum -s) automatically authorizes the active local operating system user without requiring a password.
• Linux Host Accounts (PAM): When running on Linux, any valid local system account can log in directly via PAM.
• Existing Databases: Upgrades and existing installations retain their previously configured passwords.

Built-in Native Core Functions & Chewtoys Suite

Documentation & User Manuals

All operational runbooks, platform guides, and security manuals are available on the Official GitHub Wiki and organized in manuals/:

• Power Tools & Chewtoys Manual — 3D CAD Studio, Splitter & Combiner, PDF Studio, Sharing Center, Disk Usage, Notes, Media Player, Terminal, Vaults.
• Keyboard Shortcuts & Navigation — Orthodox F1–F10 keys, media player keys, touch gestures.
• Configuration Guide (config.toml) — Master config options, storage roots, sandboxing.
• Remote Protocols & VFS Guide — SFTP, SMB, NFS, WebDAV, S3, Proton Drive, Hetzner.
• Transparent Encrypted Vaults Guide — Argon2id + AES-256-GCM in-memory containers.
• Advanced Sharing & Client Portals — Public links, granular ACLs, dynamic watermarking, upload dropzones.
• Windows Desktop & Packaging — Winget, Scoop, NSIS Setup, MSI, and Portable ZIP.
• Docker Deployment Guide — Compose, Portainer, and volume persistence.
• Proxmox VE & LXC Containers — 1-click Debian LXC container setup.
• Reverse Proxy & Mesh VPN Guide — Tailscale, NetBird, Caddy 2, Nginx, Traefik, Cloudflare.
• GitHub Milestones & Roadmap — Active milestones, roadmap vision, and release targets.
• GitHub Issues & Sprint Backlog — Feature backlog, bug triage, and active sprint items.
• Changelog — Release notes and version history.

Support & Contributions

If you find Brum useful and would like to support ongoing development, consider buying a coffee:

License

MIT License © Bolt J Woofson @ Woofsons Lab