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 13670df Update README.md
13670df is described below
commit 13670dfaf3007fde46978f940764ece4ebe3dbb3
Author: Daniel Gruno <[email protected]>
AuthorDate: Wed Aug 26 13:18:27 2020 +0200
Update README.md
---
README.md | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 8fe854c..9790783 100644
--- a/README.md
+++ b/README.md
@@ -7,13 +7,24 @@ This repository aims to contain the next generation of Apache
Pony Mail,
a pure python version of Apache Pony Mail with support for ElasticSearch 6.x
and above.
-### Roadmap
+## Roadmap
Work is underway on the following items:
- Improved archiver and import tools **[DONE]**
- New UI for the end user **[DONE]**
- 100% python backend, no mod_lua required. **[COMING SOON]**
+## Installation Guide
+Work is under way to write an installation guide for this.
+As several components are not finished or in working order yet, this is
pending.
+
+### Current setup requirements:
+
+- Linux or other UNIX based operating system (Windows has not been tested, but
might work).
+- Python 3.8 or higher with dependencies from `requirements.txt`.
+- Web server with proxy capabilities for the UI.
+- ElasticSearch 6.x or higher, 7.x recommended.
+
### Migration disclaimer:
_While compatible with the original Pony Mail, this will not be a drop-in
replacement.
