evoadmin-mail/README.md

61 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2018-12-26 21:06:16 +01:00
# Evoadmin Mail
2017-10-13 12:07:50 +02:00
2018-12-26 21:06:16 +01:00
Evoadmin-mail is a web interface to an LDAP directory designed for
mail accounts.
2017-10-13 12:07:50 +02:00
2018-03-08 13:04:50 +01:00
## Install
2017-10-13 12:07:50 +02:00
2018-12-26 21:06:16 +01:00
Evoadmin-mail requirements are an LDAP server, a web server and
PHP. See [INSTALL](docs/install.md) for instructions.
2018-11-21 16:38:17 +01:00
2018-12-26 21:06:16 +01:00
Multiples services can be configured to use the LDAP directory
2022-07-15 10:29:30 +02:00
managed by Evoadmin-mail:
2018-11-21 16:38:17 +01:00
- TODO
2017-10-13 12:07:50 +02:00
2018-03-08 13:04:50 +01:00
## Test
2022-07-15 10:29:30 +02:00
You can deploy a test environment with Vagrant:
2018-03-08 13:04:50 +01:00
~~~
vagrant up
~~~
2018-12-26 21:06:16 +01:00
Evoadmin-mail uses the evoadminmail.packmail.example.com domain
2022-07-15 10:29:30 +02:00
on localhost, so update your /etc/hosts:
2018-03-08 13:04:50 +01:00
~~~
2018-11-09 13:40:05 +01:00
127.0.0.1 evoadminmail.packmail.example.com
2018-03-08 13:04:50 +01:00
~~~
2018-12-26 21:06:16 +01:00
Congratulation, Evoadmin mail is now accessible through
https://evoadminmail.packmail.example.com:8443
2018-03-08 13:04:50 +01:00
### Authentication
2018-12-26 21:06:16 +01:00
The default admin user is "evoadmin", the password is randomly
2022-07-15 10:29:30 +02:00
generated and can be recovered from LDAP:
2018-03-08 13:04:50 +01:00
~~~
vagrant ssh
sudo -i
ldapvi --ldapsearch "(uid=evoadmin)" | grep userPassword | awk '{ print $2 }'
~~~
### Deployment
2018-12-26 21:06:16 +01:00
Launch rsync-auto in a terminal to automatically synchronise your
2022-07-15 10:29:30 +02:00
local code with the Vagrant VM:
2018-03-08 13:04:50 +01:00
~~~
vagrant rsync-auto
~~~
## License
2017-10-13 12:07:50 +02:00
2018-12-26 21:06:16 +01:00
This is an [Evolix](https://evolix.com) project and is licensed
under the AGPLv3, see the [LICENSE](LICENSE) file for details.
2017-10-13 12:07:50 +02:00
2018-12-26 21:06:16 +01:00
The Evolix trademark and logo are not freely reusable and are
protected by copyright.