|
@@ -1,8 +1,11 @@
|
|
|
# txt2mail
|
|
|
+### Purpose
|
|
|
+Ship files, e.g. logs or status reports via e-mail.
|
|
|
|
|
|
-Sends the content of each text file moved from the folder `1-prep` to `2-ready` via e-mail.
|
|
|
-First line is set as subject and all following lines as message body.
|
|
|
-When done, the mail is moved to `3-done`
|
|
|
+### Functionality
|
|
|
+This image sends the content of each text file moved from the folder `1-prep` to `2-ready` via e-mail.
|
|
|
+The first line of the text file is set as mail subject and all following lines as message body.
|
|
|
+When done, the mail is moved to `3-done`.
|
|
|
|
|
|
```
|
|
|
mail/
|
|
@@ -11,12 +14,14 @@ mail/
|
|
|
└── 3-done
|
|
|
```
|
|
|
|
|
|
-## Configuration
|
|
|
+### Configuration
|
|
|
1. `cp .env.template .env`
|
|
|
2. Set your mail config in .env
|
|
|
|
|
|
-## Usage
|
|
|
-`docker-compose up -d`
|
|
|
+### Usage
|
|
|
+- `docker-compose up -d`
|
|
|
+- Bind-mount `txt2mail/data/mail`
|
|
|
|
|
|
-## Remarks
|
|
|
+### Remarks
|
|
|
- This container runs as uid/gid 1000
|
|
|
+- The `mail/` folder is created on first startup if it doesn't exist
|