https://github.com/instrumentisto/haraka-docker-image
Haraka mail server Docker image
https://github.com/instrumentisto/haraka-docker-image
docker-haraka docker-mailserver docker-smtp haraka-docker haraka-docker-image smtp smtp-docker
Last synced: 6 months ago
JSON representation
Haraka mail server Docker image
- Host: GitHub
- URL: https://github.com/instrumentisto/haraka-docker-image
- Owner: instrumentisto
- License: other
- Created: 2020-11-18T17:17:33.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-07-16T09:58:57.000Z (7 months ago)
- Last Synced: 2025-07-17T13:36:05.941Z (7 months ago)
- Topics: docker-haraka, docker-mailserver, docker-smtp, haraka-docker, haraka-docker-image, smtp, smtp-docker
- Language: Makefile
- Homepage: https://haraka.github.io
- Size: 136 KB
- Stars: 22
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
Haraka Docker image
===================
[](https://github.com/instrumentisto/haraka-docker-image/releases)
[](https://github.com/instrumentisto/haraka-docker-image/actions?query=workflow%3ACI+branch%3Amain)
[](https://hub.docker.com/r/instrumentisto/haraka)
[Docker Hub](https://hub.docker.com/r/instrumentisto/haraka)
| [GitHub Container Registry](https://github.com/orgs/instrumentisto/packages/container/package/haraka)
| [Quay.io](https://quay.io/repository/instrumentisto/haraka)
[Changelog](https://github.com/instrumentisto/haraka-docker-image/blob/main/CHANGELOG.md)
## Supported tags and respective `Dockerfile` links
- [`3.1.1-node24-r2`, `3.1.1`, `3.1`, `3`, `latest`][d1]
## Supported platforms
- `linux`: `amd64`, `arm64v8`
## What is Haraka?
[Haraka] is an open source [SMTP] server written in [Node.js] which provides extremely high performance coupled with a flexible plugin system allowing [Javascript] programmers full access to change the behaviour of the server.
> [haraka.github.io][Haraka]
> [github.com/haraka/Haraka](https://github.com/haraka/Haraka)
## How to use this image
To run [Haraka] mail server just start the container:
```bash
docker run -d -p 25:25 instrumentisto/haraka
```
### Configuration
By default, image uses default configuration files in `/etc/haraka/config/` directory. To use a custom configuration file you should mount it:
```bash
docker run -d -p 25:25 \
-v /path/to/my/smtp.ini:/etc/haraka/config/smtp.ini:ro \
instrumentisto/haraka
```
### Plugins
__Note!__ Once you've installed [Haraka plugins][1], do not forget to enable them in `/etc/haraka/config/plugins` file.
#### NPM packaged
[NPM packaged plugins][2] can be easily installed via `HARAKA_INSTALL_PLUGINS` environment variable. Specify it as comma-separated [NPM] packages, and the container will run `npm install` on its startup:
```bash
docker run -d -p 25:25 \
-v /path/to/my/plugins:/etc/haraka/config/plugins:ro \
-e HARAKA_INSTALL_PLUGINS=haraka-plugin-rcpt-postgresql,haraka-plugin-auth-enc-file@1.0 \
instrumentisto/haraka
```
#### Legacy
Legacy custom plugin files may be mounted directly into `/etc/haraka/plugins` directory:
```bash
docker run -d -p 25:25 \
-v /path/to/my-awesome-plugin.js:/etc/haraka/plugins/my-awesome-plugin.js:ro \
-v /path/to/my/plugins:/etc/haraka/config/plugins:ro \
instrumentisto/haraka
```
#### [Alpine][11] packages
Some plugins (like [`tls`][3]) may require additional system libraries being installed. Use `APK_INSTALL_PACKAGES` environment variable to pre-install them on container startup:
```bash
docker run -d -p 25:25 \
-v /path/to/my/plugins:/etc/haraka/config/plugins:ro \
-e APK_INSTALL_PACKAGES=openssl \
instrumentisto/haraka
```
## Image tags
This image is based on the popular [Alpine Linux project][11], available in [the alpine official image][12]. [Alpine Linux][11] is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc][13] instead of [glibc and friends][14], so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread][15] for more discussion of the issues that might arise and some pro/con comparisons of using [Alpine][11]-based images.
### ``
Latest tag of the latest major `X` [Haraka] version.
This is a multi-platform image.
### ``
Latest tag of the latest minor `X.Y` [Haraka] version.
This is a multi-platform image.
### ``
Latest tag of the concrete `X.Y.Z` [Haraka] version.
This is a multi-platform image.
### `-node-r`
Concrete `N` image revision tag of the concrete `X.Y.Z` [Haraka] version installed with `A` major version of [Node.js].
Once built, it's never updated.
This is a multi-platform image.
### `-node-r--`
Concrete `N` image revision tag of the concrete `X.Y.Z` [Haraka] version installed with `A` major version of [Node.js] on the concrete `os` and `arch`.
Once built, it's never updated.
This is a single-platform image.
## License
[Haraka] is licensed under [MIT license][91].
As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).
As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.
The [sources][92] for producing `instrumentisto/haraka` Docker images are licensed under [Blue Oak Model License 1.0.0][93].
## Issues
We can't notice comments in the [DockerHub] (or other container registries) so don't use them for reporting issue or asking question.
If you have any problems with or questions about this image, please contact us through a [GitHub issue][101].
[DockerHub]: https://hub.docker.com
[Javascript]: https://javascript.com
[Haraka]: https://haraka.github.io
[Node.js]: https://nodejs.org
[NPM]: https://www.npmjs.com
[SMTP]: https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol
[1]: https://haraka.github.io/core/Plugins
[2]: https://haraka.github.io/core/Plugins#plugins-as-modules
[3]: https://haraka.github.io/plugins/tls
[11]: http://alpinelinux.org
[12]: https://hub.docker.com/_/alpine
[13]: http://www.musl-libc.org
[14]: http://www.etalabs.net/compare_libcs.html
[15]: https://news.ycombinator.com/item?id=10782897
[91]: https://github.com/haraka/Haraka/blob/master/LICENSE
[92]: https://github.com/instrumentisto/haraka-docker-image
[93]: https://github.com/instrumentisto/haraka-docker-image/blob/main/LICENSE.md
[101]: https://github.com/instrumentisto/haraka-docker-image/issues
[d1]: https://github.com/instrumentisto/haraka-docker-image/blob/main/Dockerfile