Skip to content

Repository files navigation

Bulwark Webmail

Build Status Last Commit

Modern self-hosted webmail client for Stalwart Mail Server, powered by JMAP.

Port 3000
Registry ghcr.io/daemonless/bulwark-webmail
Source https://github.com/bulwarkmail/webmail
Website https://bulwarkmail.org/

Version Tags

Tag Description Best For
latest Upstream Binary. Built from official release. Most users — recommended.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

services:
  bulwark-webmail:
    image: "ghcr.io/daemonless/bulwark-webmail:latest"
    container_name: bulwark-webmail
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC  # Timezone for the container
      - JMAP_SERVER_URL=https://mail.example.com  # URL of your Stalwart JMAP server (e.g. https://mail.example.com)
    volumes:
      - "/path/to/containers/bulwark-webmail:/config"
    ports:
      - "3000:3000"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

AppJail Director

.env:

# .env

DIRECTOR_PROJECT=bulwark-webmail
PUID=1000
PGID=1000
TZ=UTC
JMAP_SERVER_URL=https://mail.example.com

appjail-director.yml:

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  bulwark-webmail:
    name: bulwark_webmail
    options:
      - container: 'boot args:--pull'
      - expose: '3000:3000 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
        - JMAP_SERVER_URL: !ENV '${JMAP_SERVER_URL}'
    volumes:
      - bulwark-webmail: /config
volumes:
  bulwark-webmail:
    device: '/path/to/containers/bulwark-webmail'

Makejail:

# Makejail

ARG tag=latest

OPTION overwrite=force
OPTION from=ghcr.io/daemonless/bulwark-webmail:${tag}

Save the files above, then run appjail-director up.

Note: Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the IPv4 address assigned by the virtual network.

Podman CLI

podman run -d --name bulwark-webmail \
  -p 3000:3000 \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -e JMAP_SERVER_URL=https://mail.example.com \
  -v /path/to/containers/bulwark-webmail:/config \
  ghcr.io/daemonless/bulwark-webmail:latest

Save as run.sh, then run sh run.sh.

AppJail

appjail oci run -Pd \
  -o overwrite=force \
  -o container="args:--pull" \
  -o virtualnet=":<random> default" \
  -o nat \
  -o expose="3000:3000 proto:tcp" \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -e JMAP_SERVER_URL=https://mail.example.com \
  -o fstab="/path/to/containers/bulwark-webmail /config <pseudofs>" \
  ghcr.io/daemonless/bulwark-webmail:latest bulwark-webmail

Save as run.sh, then run sh run.sh.

Note: Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the IPv4 address assigned by the virtual network.

Bastille

Warning

Bastille's OCI support is experimental. It requires buildah, shares the host network stack (inherit), and persists image-declared volumes under --data-path.

services:
  bulwark-webmail:
    image: "ghcr.io/daemonless/bulwark-webmail:latest"
    container_name: bulwark-webmail
    network_mode: host  # jail shares host networking
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - JMAP_SERVER_URL=https://mail.example.com

Save as podman-compose.yml, then run bastille up. Or via CLI:

bastille create -O \
  --env PUID=1000 \
  --env PGID=1000 \
  --env TZ=UTC \
  --env JMAP_SERVER_URL=https://mail.example.com \
  --data-path /path/to/containers/bulwark-webmail \
  bulwark-webmail ghcr.io/daemonless/bulwark-webmail:latest inherit

Ansible

- name: Deploy bulwark-webmail
  containers.podman.podman_container:
    name: bulwark-webmail
    image: "ghcr.io/daemonless/bulwark-webmail:latest"
    state: started
    restart_policy: always
    env:
      PUID: "1000"
      PGID: "1000"
      TZ: "UTC"
      JMAP_SERVER_URL: "https://mail.example.com"
    ports:
      - "3000:3000"
    volumes:
      - "/path/to/containers/bulwark-webmail:/config"

Save as bulwark-webmail-deploy.yaml, then run ansible-playbook bulwark-webmail-deploy.yaml.

Access at: http://localhost:3000

Parameters

Environment Variables

Variable Default Description
PUID 1000
PGID 1000
TZ UTC Timezone for the container
JMAP_SERVER_URL https://mail.example.com URL of your Stalwart JMAP server (e.g. https://mail.example.com)

Volumes

Path Description
/config Admin config, settings sync, and telemetry state

Ports

Port Protocol Description
3000 TCP Web UI

Architectures: amd64 User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15


Need help? Join our Discord community.

About

Modern self-hosted webmail client for Stalwart Mail Server, powered by JMAP.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages