diff --git a/FEATURES.md b/FEATURES.md index aac5e389..37638ba2 100644 --- a/FEATURES.md +++ b/FEATURES.md @@ -2,19 +2,23 @@ ## Mail -- Read, compose, reply, reply-all, and forward with a Tiptap rich text editor (inline images, drag-and-drop embedding) +- Read, compose, reply, reply-all, and forward with a Tiptap rich text editor (inline images, drag-and-drop embedding, tables) - Gmail-style threading with inline expansion and an optional conversation toggle - Unified mailbox view across all connected accounts -- Draft auto-save with identity preservation -- Attachment upload, download, and inline preview; forgotten-attachment warning +- Three selectable mail layouts: split (three-pane), focused list, and reading pane at bottom +- Draft auto-save with identity preservation, persisted HTML body, and proper `In-Reply-To` / `References` headers on replies +- Attachment upload, download, drag-out to local file system, and inline preview; image thumbnails and forgotten-attachment warning - Full-text search with JMAP filter panel, search chips, wildcards, OR conditions, and cross-mailbox queries - Batch operations – multi-select, archive, delete, move, tag - Archive modes – direct, by year, or by month - Multi-tag support with color labels, reordering, and drag-and-drop assignment - Star/unstar with configurable mark-as-read delay -- Virtual scrolling for large mailboxes +- Virtual scrolling for large mailboxes plus prefetching of initial email data on login - Quick reply, hover actions, sender avatars (favicon-based), and recipient popovers - Plain-text composer mode and Reply-To support +- Configurable signature position (above or below quoted text) per identity +- From-header override in the composer with optional catch-all auto-reply: replies to an alias on a domain you own auto-fill the alias as the sender even when it isn't a configured identity +- `.eml` file import via folder right-click menu - TNEF (`winmail.dat`) extraction and `message/rfc822` unwrapping - Folder management with icon picker, subfolders, and sidebar counts - Print directly from the viewer @@ -79,7 +83,7 @@ ## Interface -- Three-pane layout with resizable columns +- Selectable mail layouts (split three-pane, focused list, reading pane at bottom) with resizable columns - Dark and light themes with intelligent email color transformation - Responsive desktop, tablet, and mobile layouts - Full keyboard navigation @@ -100,25 +104,32 @@ Automatic browser detection with persistent preference. Configurable locale URL ## Identity & Multi-Account -- Up to 5 simultaneous accounts with instant switching and per-account session persistence +- Multiple simultaneous accounts with instant switching and per-account session persistence; the 5-account cap is lifted on HTTP/2 servers (limited by browser connection pooling on HTTP/1.1) - Account switcher with connection status and default account selection - Multiple sender identities with per-identity signatures, automatic sync, and badges in viewer/list -- Sub-addressing (`user+tag@domain.com`) with contextual tag suggestions +- Configurable signature position (above or below quoted text) +- Sub-addressing (`user+tag@domain.com`) with configurable delimiter and contextual tag suggestions - Shared folders across accounts +- Multiple JMAP servers per deployment with optional auto-pick by email domain - Optional custom JMAP endpoints on the login form (`ALLOW_CUSTOM_JMAP_ENDPOINT`) ## Admin & Extensibility -- Stalwart admin dashboard with dedicated policy sections -- Plugin system – schema-driven config UI, render and intercept hooks, `onAvatarResolve` and i18n APIs, calendar event slots, and managed policy enforcement +- Web setup wizard for first launch – guides through JMAP server(s), OAuth/OIDC, session secret, logging, branding (with file upload), and admin password; persists to the admin config dir, no `.env.local` editing required +- Stalwart admin dashboard with dedicated policy sections, collapsed into a single tabbed page +- Split admin storage: `ADMIN_CONFIG_DIR` (operator-authored, mountable read-only after setup) and `ADMIN_STATE_DIR` (runtime audit log and login timestamps) +- Plugin system – schema-driven config UI, render and intercept hooks, `onAvatarResolve`, `onBeforeEmailSend`, composer-sidebar and email-banner slots, calendar event slots, i18n APIs, and managed policy enforcement +- Plugin hot-reload and dev-folder loading, on-demand `src/` bundling via esbuild, and `http:fetch` permission with `httpOrigins` - Themes – upload, enforce, and manage admin-controlled themes as ZIP bundles -- Extension marketplace – browse and install plugins and themes from a configurable directory (`EXTENSION_DIRECTORY_URL`) +- Extension marketplace – browse and install plugins and themes from a configurable directory (`EXTENSION_DIRECTORY_URL`); install/uninstall restricted to the admin dashboard - Bundled plugins including Jitsi Meet calendar integration ## Operations -- Progressive Web App with service worker, install prompt, and dynamic manifest -- Automatic update check with server-side logging of new releases +- Progressive Web App with service worker, install prompt, web push notifications for inbox mail, and dynamic manifest +- Automatic update check with server-side logging of new releases and a non-dismissible update notice - Structured logging (`text` or `json`) with category-based levels +- Anonymous instance telemetry (opt-out via admin UI or `BULWARK_TELEMETRY=off`) – version, platform, bucketed account counts, feature toggles only - Release (`main`) and development (`dev`) Docker images on GHCR +- Subpath deployment via `NEXT_PUBLIC_BASE_PATH` for mounting behind a reverse proxy - Demo mode with fixture data – no mail server required diff --git a/README.md b/README.md index eb830e07..e8851626 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ A modern, self-hosted webmail client for [Stalwart Mail Server](https://stalw.ar [![License: AGPL v3](https://img.shields.io/badge/license-AGPL%20v3-blue.svg?logo=gnu&logoColor=white)](LICENSE) [![Discord](https://img.shields.io/discord/1482128142939455674?color=7289da&label=discord&logo=discord&logoColor=white)](https://discord.gg/tYCujymGrT) -[![Version](https://img.shields.io/badge/version-1.6.1-green.svg?logo=git&logoColor=white)](CHANGELOG.md) +[![Version](https://img.shields.io/badge/version-1.6.3-green.svg?logo=git&logoColor=white)](CHANGELOG.md) [![Docker](https://img.shields.io/badge/docker-ghcr.io%2Fbulwarkmail%2Fwebmail-blue?logo=docker&logoColor=white)](https://ghcr.io/bulwarkmail/webmail) [![Grafana](https://img.shields.io/badge/grafana-dashboard-orange?logo=grafana&logoColor=white)](https://grafana.external.bulwarkmail.org/) @@ -63,7 +63,7 @@ Bulwark is a full webmail suite, not just an inbox. It bundles the four apps mos - **Contacts** – multiple address books, groups, vCard import/export - **Files** – Stalwart's JMAP FileNode storage with previews and folder upload -Plus the infrastructure around them: OAuth2 / OIDC SSO, TOTP 2FA, multi-account (up to 5 at once), 15 languages, PWA install, dark/light themes, a plugin system with an extension marketplace, and a admin dashboard. +Plus the infrastructure around them: a web setup wizard, OAuth2 / OIDC SSO, TOTP 2FA, multi-account with HTTP/2 connection pooling, 15 languages, PWA install, dark/light themes, a plugin system with an extension marketplace, and an admin dashboard. Full feature list: **[FEATURES.md](FEATURES.md)**. @@ -74,28 +74,25 @@ Full feature list: **[FEATURES.md](FEATURES.md)**. ### Docker ```bash -docker run -d -p 3000:3000 \ - -e JMAP_SERVER_URL=https://mail.example.com \ - ghcr.io/bulwarkmail/webmail:latest +docker run -d -p 3000:3000 ghcr.io/bulwarkmail/webmail:latest ``` Or with Docker Compose: ```bash -cp .env.example .env.local -# Edit .env.local – set JMAP_SERVER_URL docker compose up -d ``` +On first launch, open `http://localhost:3000` – the **web setup wizard** walks you through JMAP server, OAuth, branding, and the admin password. No `.env.local` editing required. Existing installs that already define `JMAP_SERVER_URL` in their environment skip the wizard and keep the env-managed flow described under [Configuration](#configuration). + ### From Source ```bash git clone https://github.com/bulwarkmail/webmail.git cd webmail npm install -cp .env.example .env.local -# Edit .env.local – set JMAP_SERVER_URL npm run build && npm start +# Then open http://localhost:3000 to run the setup wizard ``` ### Development @@ -108,13 +105,13 @@ npm run lint ## Configuration +Most deployments are configured through the **setup wizard** (on first launch) and the **admin dashboard** thereafter; values are written to the admin config directory rather than `.env.local`. Environment variables remain supported for operators who prefer file-driven configuration or read-only / immutable infrastructure. When an environment variable is set, it takes precedence over the corresponding admin-managed value, so setting `JMAP_SERVER_URL` will hide that field from the wizard and lock it in the admin UI. + All variables are evaluated at runtime, so Docker deployments can be reconfigured without rebuilding. Edit `.env.local`: ```env -# Required +# Optional – overrides whatever the wizard writes JMAP_SERVER_URL=https://mail.example.com - -# Optional APP_NAME=My Webmail ``` @@ -218,6 +215,19 @@ LOG_LEVEL=info # error | warn | info | debug +
+Admin data directories + +```env +ADMIN_CONFIG_DIR=./data/admin # operator-authored: config.json, policy.json, plugins/, themes/ +ADMIN_STATE_DIR=./data/admin-state # runtime: audit log, login timestamps, setup token +ADMIN_CONFIG_READONLY=true # enforce read-only mode at the app layer +``` + +The split lets you mount the config volume read-only after the setup wizard completes. Legacy installs that pre-date the split keep working through `ADMIN_DATA_DIR`. + +
+
Subpath / reverse proxy mount