Update README with testing docs
This commit is contained in:
parent
24cc53521f
commit
e3e1393273
38
README.md
38
README.md
|
@ -2,11 +2,45 @@
|
||||||
|
|
||||||
Evoadmin mail is a Web Interface for manage an LDAP directory designed for mail accounts.
|
Evoadmin mail is a Web Interface for manage an LDAP directory designed for mail accounts.
|
||||||
|
|
||||||
# Install
|
## Install
|
||||||
|
|
||||||
See [INSTALL](docs/INSTALL.md).
|
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).
|
Evoadmin-mail are in GPLv2+, see [LICENSE](LICENSE).
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue