An open API service indexing awesome lists of open source software.

https://github.com/daemonless/bulwark-webmail


https://github.com/daemonless/bulwark-webmail

Last synced: 4 days ago
JSON representation

Awesome Lists containing this project

README

          

# Bulwark Webmail

[![Build Status](https://img.shields.io/github/actions/workflow/status/daemonless/bulwark-webmail/build.yaml?style=flat-square&label=Build&color=green)](https://github.com/daemonless/bulwark-webmail/actions)
[![Last Commit](https://img.shields.io/github/last-commit/daemonless/bulwark-webmail?style=flat-square&label=Last+Commit&color=blue)](https://github.com/daemonless/bulwark-webmail/commits)

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](https://github.com/bulwarkmail/webmail) |
| **Website** | [https://bulwarkmail.org/](https://bulwarkmail.org/) |

## Version Tags

| Tag | Description | Best For |
| :--- | :--- | :--- |
| `latest` | **Upstream Binary**. Built from official release. | Most users. Matches Linux Docker behavior. |

## Prerequisites

Before deploying, ensure your host environment is ready. See the [Quick Start Guide](https://daemonless.io/guides/quick-start) for host setup instructions.

## Deployment

### Podman Compose

```yaml
services:
bulwark-webmail:
image: ghcr.io/daemonless/bulwark-webmail:latest
container_name: bulwark-webmail
environment:
- PUID=1000
- PGID=1000
- TZ=UTC
- JMAP_SERVER_URL=https://mail.example.com
volumes:
- "/path/to/containers/bulwark-webmail:/config"
ports:
- 3000:3000
restart: unless-stopped
```

### AppJail Director

**.env**:

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

**appjail-director.yml**:

```yaml
options:
- virtualnet: ': default'
- nat:
services:
bulwark-webmail:
name: bulwark_webmail
options:
- container: 'boot args:--pull'
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**:

```
ARG tag=latest

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

### Podman CLI

```bash
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
```

### Ansible

```yaml
- 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"
```

## 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.0

---

Need help? Join our [Discord](https://discord.gg/Kb9tkhecZT) community.