From e3e13932735169dbd4ef5c1999c43808723d990c Mon Sep 17 00:00:00 2001 From: Victor LABORIE Date: Thu, 8 Mar 2018 13:04:50 +0100 Subject: [PATCH] Update README with testing docs --- README.md | 38 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 36 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f073394..b26334e 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,45 @@ Evoadmin mail is a Web Interface for manage an LDAP directory designed for mail accounts. -# Install +## Install See [INSTALL](docs/INSTALL.md). -# License +## Test + +You can deploy a test environmment with Vagrant : + +~~~ +vagrant up +~~~ + +Evoadmin mail respond to evoadminmail.evoadmin-mail.example.com domain on localhost, so update your /etc/hosts : + +~~~ +127.0.0.1 evoadminmail.evoadmin-mail.example.com +~~~ + +Congratulation, Evoadmin mail is now accessible throught https://evoadminmail.evoadmin-mail.example.com:8443 + +### Authentication + +Default admin user is "evoadmin", password is randomly generated and can be recovered from LDAP : + +~~~ +vagrant ssh +sudo -i +ldapvi --ldapsearch "(uid=evoadmin)" | grep userPassword | awk '{ print $2 }' +~~~ + +### Deployment + +Launch rsync-auto in a terminal for automatic synchronisation of your local code with Vagrant VM : + +~~~ +vagrant rsync-auto +~~~ + +## License Evoadmin-mail are in GPLv2+, see [LICENSE](LICENSE).