Documentation
Everything you need to get started with Bulwark.
Getting Started
- Stalwart SetupConfigure Stalwart Mail Server for use with Bulwark.
- IntroductionLearn what Bulwark is and why it was built.
- AuthenticationAuthentication methods supported by Bulwark.
- InstallationHow to install and run Bulwark locally.
- Environment ReferenceComplete reference for every variable in Bulwark's .env.example.
- ConfigurationConfigure Bulwark for your environment.
Features
- Composing EmailsRich text editor and composing features.
- EmailEmail features and capabilities in Bulwark.
- CalendarCalendar and event management features.
- Search & FiltersFull-text search and filtering capabilities.
- ContactsContact management features.
- FilesCloud file browser and JMAP FileNode storage features.
- Progressive Web AppInstall Bulwark to your home screen with a service worker and dynamic manifest.
- Anonymous Usage StatsHow Bulwark phones home — what we count, why, and how to turn it off.
Deployment
Guides
- CustomizationCustomize the look and feel of Bulwark.
- Keyboard ShortcutsAll keyboard shortcuts available in Bulwark.
- Embedded SSOEmbed Bulwark in an iframe with automatic single sign-on managed by a parent portal.
- PluginsPlugin system for extending Bulwark with custom functionality.
- Account SecurityManage password, 2FA, app passwords, and API keys from within Bulwark.
- Multi-Account SupportManage up to 5 simultaneous email accounts in Bulwark.
- S/MIMESign, encrypt, decrypt, and verify mail with S/MIME certificates.
- Extension MarketplaceBrowse and install plugins and themes from a configurable extension directory.
- Admin DashboardManage runtime configuration, plugins, themes, API keys, and policy from a single place.
Extensions
- IntroductionBuild plugins and themes for Bulwark Webmail and publish them on the Bulwark Extensions directory.
- manifest.json referenceRequired fields, permissions, and metadata for Bulwark extensions.
- REST API referenceThe public REST API of the Bulwark Extensions directory.
- Submission guidelinesRequirements, review process, and content policy for publishing extensions on the Bulwark directory.
- Publishing & updatesHow to publish a new extension and ship updates through the Bulwark directory.