Files
mailu/README.md
2025-01-08 12:41:02 -05:00

53 lines
1.6 KiB
Markdown

# Mailu
Coöp Cloud + [Mailu][Mailu] = 🥳
<!-- metadata -->
* **Category**: Apps
* **Status**: 1, alpha
* **Image**: [`mailu/*`](https://hub.docker.com/r/mailu/), 4, upstream
* **Healthcheck**: No
* **Backups**: No
* **Email**: N/A
* **Tests**: No
* **SSO**: No
<!-- endmetadata -->
NOTE: Mailu requires "host-mode" networking so that containers are aware of
remote IP addresses. This means that you can only deploy one Mailu instance per
host.
## Basic usage
1. Set up Docker Swarm and [`abra`][abra]
2. Deploy [`coop-cloud/traefik`][compose-traefik]
3. `abra app new mailu`
4. `abra app config YOURAPPDOMAIN` - be sure to change `$WEB_DOMAIN` to something that resolves to
your Docker swarm box
5. `abra app deploy YOURAPPDOMAIN`
6. Create initial user:
```
abra app run YOURDOMAIN admin flask mailu admin admin YOURDOMAIN YOURPASSWORD
```
## Upgrading the recipe
**NOTE** This section is only intended for [recipe maintainers][maintainers]
Minor/patch updates usually work OK with `abra recipe upgrade` and friends.
For major updates:
1. Go to https://setup.mailu.io/ and generate a new config
2. Download the new config and compare it to `compose.yml`. Pay attention to:
- New / removed services
- Added/removed config options
- Changes to networking
3. Test upgrading from the previous version to the new version
4. `abra recipe sync` / `abra recipe release` as normal
[Mailu]: https://mailu.io/
[abra]: https://git.autonomic.zone/autonomic-cooperative/abra
[compose-traefik]: https://git.autonomic.zone/coop-cloud/traefik
[maintainers]: https://docs.coopcloud.tech/maintainers/