https://github.com/JSONbored/simplelogin-aio
SimpleLogin All-in-One Docker image for Unraid — self-host your own email alias service with automatic DKIM, database migrations, and s6-overlay process supervision
https://github.com/JSONbored/simplelogin-aio
dkim docker docker-compose email-alias email-forwarding email-privacy email-security homelab open-source postfix privacy protonmail s6-overlay self-hosted self-hosting simplelogin tailscale unraid unraid-community-apps unraid-templates
Last synced: about 1 month ago
JSON representation
SimpleLogin All-in-One Docker image for Unraid — self-host your own email alias service with automatic DKIM, database migrations, and s6-overlay process supervision
- Host: GitHub
- URL: https://github.com/JSONbored/simplelogin-aio
- Owner: JSONbored
- Created: 2026-03-22T06:08:06.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2026-05-02T09:02:49.000Z (about 1 month ago)
- Last Synced: 2026-05-02T10:29:35.823Z (about 1 month ago)
- Topics: dkim, docker, docker-compose, email-alias, email-forwarding, email-privacy, email-security, homelab, open-source, postfix, privacy, protonmail, s6-overlay, self-hosted, self-hosting, simplelogin, tailscale, unraid, unraid-community-apps, unraid-templates
- Language: Shell
- Homepage: https://aethereal.dev
- Size: 324 KB
- Stars: 5
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Support: docs/support-thread-template.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
# SimpleLogin-AIO
---
An Unraid-first, single-container deployment of [SimpleLogin](https://github.com/simple-login/app) for people who want the self-hosted alias stack without manually wiring separate Postgres, Redis, and Postfix containers.
`simplelogin-aio` packages the web UI, background jobs, inbound email handler, Postfix, PostgreSQL, and Redis into one image with persistent Unraid appdata paths. The wrapper is opinionated for a reliable first boot, but it does not hide the real complexity of self-hosted mail: DNS, inbound port 25, SPF/DKIM/DMARC, and sender reputation still matter.
## What This Image Includes
- SimpleLogin web UI on port `7777`
- Background job runner
- Inbound email handler
- Embedded PostgreSQL
- Embedded Redis
- Embedded Postfix for inbound and outbound mail routing
- Unraid CA template at [simplelogin-aio.xml](simplelogin-aio.xml)
## Beginner Install
If you want the simplest supported path:
1. Install the Unraid template.
2. Set `URL`, `EMAIL_DOMAIN`, `SUPPORT_EMAIL`, and `FLASK_SECRET`.
3. Pick a relay mode if your ISP blocks outbound TCP 25.
4. Leave dropdown-style advanced enum fields such as `ADMIN_FIDO_REQUIRED` on their documented values only. For most installs that means leaving `ADMIN_FIDO_REQUIRED=none`.
5. Forward inbound TCP 25 from your router/firewall to the Unraid host.
6. Start the container and wait for first-boot initialization to complete.
7. Create your first account in the web UI, then disable registration in Advanced View if you want a private instance.
8. Add the DNS records from [docs/simplelogin-setup.md](docs/simplelogin-setup.md).
For most users, that is enough to get a working instance online.
## Power User Surface
This repo is deliberately not a stripped-down "toy" wrapper. The template now tracks the full upstream self-hosting environment surface from SimpleLogin's official `example.env`, plus AIO-specific relay controls. In Advanced View you can:
- move PostgreSQL or Redis out of the container with `DB_URI` or `REDIS_URL`
- override alias domain behavior and onboarding rules
- configure GitHub, Google, Facebook, Proton, and generic OIDC auth
- enable hCaptcha, HIBP, SpamAssassin, Plausible, and Sentry
- provide AWS, Paddle, and Coinbase settings
- mount `/custom-assets` for custom words files, OpenID keys, Paddle public keys, or other file-based upstream settings
The wrapper still defaults to the internal bundled services so beginners are not forced into a multi-container setup on day one.
## What You Get In-App
The official SimpleLogin docs describe several major capabilities that are configured inside the running app after deployment, not through extra container env vars. Once this container is up, those app features are still available without adding more containers for core infrastructure:
- custom domains and alias domains
- catch-all behavior and mailbox routing
- reverse aliases / reply flow
- multiple mailboxes
- alias directories and organization features exposed by the app UI
- login methods such as social auth, Proton auth, and generic OIDC when their related env vars are set
In other words, the template is responsible for exposing deployment-time and integration-time configuration, while the SimpleLogin web UI still handles normal application-level features after first boot.
## Runtime Notes
- Upstream SimpleLogin container support is currently `linux/amd64` only, so this wrapper publishes amd64-only images.
- First boot initializes PostgreSQL when `DB_URI` is unset, starts Redis when `REDIS_URL` is unset, writes the runtime `.env`, applies `alembic upgrade head`, then runs `init_app.py`.
- Before any long-running services start, the wrapper now validates the rendered SimpleLogin config and exits once with a fatal error if enum-style values are invalid.
- `/appdata` is the main persistent volume. It stores PostgreSQL, Redis, uploads, DKIM keys, generated OpenID keys, and other runtime state.
- `/pgp` is the optional persistent GnuPG home.
- `/custom-assets` is an optional advanced mount for file-based upstream settings.
- DKIM keys are persisted under `/appdata/dkim` and symlinked into the in-container paths the app expects.
## Publishing and Releases
- Wrapper releases use the upstream version plus an AIO revision, such as `v4.80.1-aio.1`.
- Upstream monitoring, release preparation, registry publishing, and catalog sync are owned by `aio-fleet` from `.aio-fleet.yml`.
- Changelog generation and XML `` sync are run centrally by `aio-fleet` during release preparation.
- `main` publishes `latest`, the pinned upstream version tag, an explicit AIO packaging line tag, and `sha-`.
- The Unraid template uses Docker Hub image tags for Community Applications metadata.
See [docs/releases.md](docs/releases.md) for the central release process details.
## Validation
Local validation is built around:
- XML validation for the audited template surface
- shell and Python syntax checks
- local Docker build on `linux/amd64`
- pytest coverage for first boot, health, SMTP readiness, restart, persistence, relay modes, fatal preflight paths, and external service overrides
- Trunk Flaky Tests JUnit XML output for CI uploads and local report validation
Run it locally with:
```bash
python3 -m venv .venv
. .venv/bin/activate
pip install -e "../aio-fleet[app-tests]"
pytest tests/unit
pytest tests/integration -m integration
```
To generate the exact JUnit XML files used by CI and validate them locally with Trunk Analytics CLI:
```bash
mkdir -p reports
pytest tests/unit --junit-xml=reports/pytest-unit.xml -o junit_family=xunit1
pytest tests/integration -m integration --junit-xml=reports/pytest-integration.xml -o junit_family=xunit1
cd ../aio-fleet
.venv/bin/python -m aio_fleet validate-repo --repo simplelogin-aio --repo-path ../simplelogin-aio
.venv/bin/python -m aio_fleet trunk run --repo simplelogin-aio --repo-path ../simplelogin-aio --no-fix
```
CI cost model:
- pull requests and pushes only run the Docker-backed integration suite when build-relevant files change
- ordinary docs-only or metadata-only changes do not trigger the expensive container matrix
- image publish remains gated behind the integration suite, so release/publish paths cannot skip it
- release metadata commits on `main` still trigger the integration suite before publish, even if they only touch changelog/release files
- nothing in this repo runs the Docker suite automatically before local commits; keep local integration runs explicit instead of turning every commit into an 8-minute pre-commit hook
## Support
- Repo issues: [JSONbored/simplelogin-aio issues](https://github.com/JSONbored/simplelogin-aio/issues)
- Upstream app: [simple-login/app](https://github.com/simple-login/app)
## Funding
If this work saves you time, support it here:
- [GitHub Sponsors](https://github.com/sponsors/JSONbored)
- [Ko-fi](https://ko-fi.com/jsonbored)
- [Buy Me a Coffee](https://buymeacoffee.com/jsonbored)
## Star History
[](https://star-history.com/#JSONbored/simplelogin-aio&Date)