Get boilerplate into the README

This commit is contained in:
decentral1se 2021-05-08 17:50:02 +02:00
parent f6c49b1535
commit 691378f291
No known key found for this signature in database
GPG Key ID: 92DAD76BD9567B8A
1 changed files with 27 additions and 1 deletions

View File

@ -1,5 +1,31 @@
# mailman3
A mailing list management system.
> https://docs.mailman3.org
> Work In Progress...
<!-- metadata -->
- **Category**:
- **Status**:
- **Image**: [`maxking/mailman-*`](https://github.com/maxking/docker-mailman)
- **Healthcheck**:
- **Backups**:
- **Email**:
- **Tests**:
- **SSO**:
<!-- endmetadata -->
## Basic usage
1. Set up Docker Swarm and [`abra`]
2. Deploy [`coop-cloud/traefik`]
3. `abra app new mailman3 --secrets` (optionally with `--pass` if you'd like
to save secrets in `pass`)
4. `abra app YOURAPPDOMAIN config` - be sure to change `$DOMAIN` to something that resolves to
your Docker swarm box
5. `abra app YOURAPPDOMAIN deploy`
6. Open the configured domain in your browser to finish set-up
[`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra
[`coop-cloud/traefik`]: https://git.autonomic.zone/coop-cloud/traefik