https://github.com/mat-sz/catchmail-docker
📦 docker-compose setup for catchmail. (E-mail debugging.)
https://github.com/mat-sz/catchmail-docker
docker docker-compose dockerfile email
Last synced: 5 months ago
JSON representation
📦 docker-compose setup for catchmail. (E-mail debugging.)
- Host: GitHub
- URL: https://github.com/mat-sz/catchmail-docker
- Owner: mat-sz
- Created: 2020-04-18T10:47:25.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-07-17T17:03:42.000Z (over 5 years ago)
- Last Synced: 2025-03-24T22:02:53.597Z (10 months ago)
- Topics: docker, docker-compose, dockerfile, email
- Size: 4.88 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# catchmail-docker
A docker-compose setup for catchmail. Contains: [catchmail-web](https://github.com/mat-sz/catchmail-web), [catchmail-ws](https://github.com/mat-sz/catchmail-ws) and [nginx](http://nginx.org/). This configuration should roughly match the production environment.
**Check other TypeScript e-mail projects:**
| Rendering (React.js) | Rendering (Vue.js) | Parser | Inbound SMTP |
| ------------------------------------------------------ | -------------------------------------------------- | ------------------------------------------------------ | ---------------------------------------------- |
| [react-letter](https://github.com/mat-sz/react-letter) | [vue-letter](https://github.com/mat-sz/vue-letter) | [letterparser](https://github.com/mat-sz/letterparser) | [microMTA](https://github.com/mat-sz/microMTA) |
## Installation
Clone the repo and run the following commands:
```
git submodule update --recursive --init
HOST=localhost PORT=80 TITLE=catchmail docker-compose up
```
Make sure docker and docker-compose are installed and your user is in the docker group. In case another reverse proxy is used make sure to change the default port (from 80) and to add the `X-Forwarded-For` header with client's IP address.
The SMTP server ([microMTA](https://github.com/mat-sz/microMTA)) is exposed at port 25, this cannot be changed.
## Environment variables
| Variable | Default value | Description |
| ------------- | ------------- | ------------------------------------------------------------------------ |
| `HOST` | `localhost` | Domain/external IP for the application. |
| `PORT` | `80` | Reverse proxy port. |
| `TITLE` | `catchmail` | Application title. |
| `AUTH_MODE` | `none` | Authentication mode. |
| `AUTH_SECRET` | (empty) | Authentication secret. |
| `LOG_MODE` | `none` | Logging mode. Set to `file` for the .eml files to be saved into `./log`. |