Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/tozd/docker-sympa

Sympa Docker image. Read-only mirror of https://gitlab.com/tozd/docker/sympa
https://github.com/tozd/docker-sympa

docker docker-image sympa

Last synced: 3 days ago
JSON representation

Sympa Docker image. Read-only mirror of https://gitlab.com/tozd/docker/sympa

Awesome Lists containing this project

README

        

# tozd/sympa

Available as:

- [`tozd/sympa`](https://hub.docker.com/r/tozd/sympa)
- [`registry.gitlab.com/tozd/docker/sympa`](https://gitlab.com/tozd/docker/sympa/container_registry)

## Image inheritance

[`tozd/base`](https://gitlab.com/tozd/docker/base) ← [`tozd/dinit`](https://gitlab.com/tozd/docker/dinit) ← [`tozd/nginx`](https://gitlab.com/tozd/docker/nginx) ← [`tozd/nginx-mailer`](https://gitlab.com/tozd/docker/nginx-mailer) ← `tozd/sympa`

## Tags

- `latest`: Sympa 6.2.66

## Volumes

- `/var/log/sympa`: Log files. Logs are **not** rotated.
- `/etc/sympa/shared`: A volume shared with a Postfix container to provide necessary SSH keys for communication between containers.
- `/var/spool/sympa`: Persist this volume to not lose state.
- `/var/lib/sympa`: Persist this volume to not lose state.

## Description

Docker image providing [Sympa](https://www.sympa.org/) mailing list service.
When the container runs Sympa is available at `/lists/` (and `/sympa/`) URLs.

You should make sure you mount spool and data volumes (`/var/spool/sympa` and `/var/lib/sympa` from this image
and `/var/spool/nullmailer` from `tozd/nginx-mailer`) so that you do not lose e-mails and mailing lists data
when you are recreating a container.

The intended use of this image is that it is extended (see [cloyne/sympa](https://github.com/cloyne/docker-sympa)
for an example) with customizations for your installation, and used together with
[tozd/postfix](https://gitlab.com/tozd/docker/postfix) for receiving and sending e-mails.
`tozd/postfix` container should be configured to use SSH to deliver e-mails to `tozd/sympa`
and use `REMOTES` environment variable to specify the container (i.e., `tozd/postfix`)
or server used for sending e-mails.
See [cloyne/postfix](https://github.com/cloyne/docker-postfix) for an example how to integrate
images together.

The image is by default configured to be used with [tozd/postgresql](https://gitlab.com/tozd/docker/postgresql)
PostgreSQL database, running in a container named `pgsql`.

**The image contains only example values and cannot run without extending (or mounting necessary files into it).**

You should provide one volume `/etc/sympa/shared` and also mount your `sympa.conf` configuration into `/etc/sympa/sympa/sympa.conf`.
You can use [image default as a starting point](./etc/sympa/sympa/sympa.conf).

To create a database for Sympa, `exec` into your PostgreSQL container and run:

```
$ createuser -U postgres -DRS -PE sympa
$ createdb -U postgres -O sympa sympa
```

## GitHub mirror

There is also a [read-only GitHub mirror available](https://github.com/tozd/docker-sympa),
if you need to fork the project there.