From c1e64a8a1747cc6d1af5d9bbb2a6abb236860ca6 Mon Sep 17 00:00:00 2001
From: "max.mehl" <max.mehl@fsfe.org>
Date: Wed, 19 May 2021 10:11:04 +0200
Subject: [PATCH] add README

---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2a11a40
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# Autoreply Editor
+
+A web frontend to edit a file to be used for automatic replies. Created to be
+used in Uberspace.de environments.
+
+## Setup
+
+1. Clone Repo, e.g. to `/home/YOURUSERNAME/autoreply-editor`
+2. Create `config.py` and `message.txt` from their sample files
+3. Install requirements: `pip3 install -r requirements.txt --user`
+4. Create web backend on uberspace: `uberspace web backend app.example.com --http --port 5000`
+5. Create a service in `~/etc/services.d/autoreply-editor.ini`:
+
+```
+[program:autoreply-editor]
+directory=/home/YOURUSERNAME/autoreply-editor
+command=gunicorn --bind 0.0.0.0:5000 wsgi:app
+startsecs=60
+```
+
+Then run: `supervisorctl reread`, `supervisorctl update`, `supervisorctl start autoreply-editor`
+
+## Autoreply Setup
+
+### Mailbot file
+
+Create `~/.filter-autoreply`:
+
+```
+logfile "$HOME/mailfilter-autoreply.log"
+
+FROM="Jane Doe <info@example.com>"
+
+to "| mailbot -T reply -t $HOME/autoreply-editor/message.txt -d $HOME/autoresponders/autoresponsedb -N -A 'From: $FROM' /var/qmail/bin/qmail-inject -f ''"
+```
+
+Make sure that the file permissions are `0600`!
+
+Afterwards, also create the directory `~/autoreply` if necessary.
+
+### .qmail file
+
+In your `.qmail` file (or for any sub-account, see Uberspace docu), write:
+
+```
+|maildrop $HOME/.filter-autoreply
+|/usr/bin/vdeliver
+```