[incubator-ponymail-foal] branch master updated: Get started on a basic installation doc

[hu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

humbedooh pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-ponymail-foal.git


The following commit(s) were added to refs/heads/master by this push:
     new ac40f55  Get started on a basic installation doc
ac40f55 is described below

commit ac40f5534429c7ee0a628302ccb1b9f5f88aec8c
Author: Daniel Gruno <hu...@apache.org>
AuthorDate: Tue Sep 8 13:48:19 2020 +0200

    Get started on a basic installation doc
---
 INSTALL.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 0000000..4c2b12d
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,49 @@
+# Installation instructions
+
+## Basic requirements
+- Linux or other UNIX-like operating system
+- ElastichSearch 6.x or higher (7.x recommended) installed
+- Python 3.7.3 or higher
+- PipEnv program (typically `apt install pipenv` or `yum install pipenv` etc)
+- A web server of your choice with proxy capabilities
+
+## Installation steps:
+
+- Clone the Foal git repository to your machine: `git clone https://github.com/apache/incubator-ponymail-foal.git foal`
+- Install the Python requirements for the setup:
+~~~shell script
+cd foal/
+pipenv install -r requirements.txt
+~~~
+- Run the setup process:
+~~~shell script
+cd tools/
+python3 setup.py
+cd ..
+~~~
+- Import any mailboxes you need to, using `tools/import-mbox.py`
+- Install the server requirements:
+~~~shell script
+cd server/
+pipenv install -r requirements.txt
+~~~
+- start the server:
+~~~shell script
+pipenv run python3 main.py
+~~~
+
+
+## Archiving new emails via Postfix or the likes
+To set up archiving, the easiest path is to edit your `/etc/aliases` file on the machine
+that receives email. If your receiving address for email is `inbox@yourmachine.tld`, your 
+alias entry should look like this:
+~~~text
+inbox: "| /path/to/foal/tools/archiver.py"
+~~~
+
+Once you have added the entry, be sure to run the `newaliases` command to update the compiled alias list.
+`archiver.py` will automatically sort out which list the email is for, if there is a List-ID header.
+You can override or manually set a list using the `--lid` flag:
+~~~text
+inbox-somealias: "| /path/to/foal/tools/archiver.py --lid somealias@mydomain.tld"
+~~~