From d953d187c2268693d992e1c8e2ed3a258e5812f4 Mon Sep 17 00:00:00 2001 From: George Dimakopoulos Date: Wed, 26 Jul 2017 16:13:00 +0300 Subject: [PATCH] documentation --- INSTALLATION.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 INSTALLATION.md diff --git a/INSTALLATION.md b/INSTALLATION.md new file mode 100644 index 0000000..5945bfd --- /dev/null +++ b/INSTALLATION.md @@ -0,0 +1,37 @@ +## Installation +composer clearcache (optional) +- Clone the current master with: git clone https://github.com/sophimail/webadmin.git +- cd webadmin +- Install dependencies: composer install +- chown -R :your-web-server-group-name webadmin + + + +## DATABASE SETUP + +Note: Database for SophiMail Webadmin must use UTF-8 character set. + +- mysql < SQL/mysql.initial.sql + + +## DSN configuration +Modify file: config/app.php + +- Default Datasource: DB: a0001 on localhost +This Database stores administrative information such as Locations, Administrators and Domains Attrubutes + +- DB1 remote Datasource, it is the actual email server database scheme (according to PostfixAdmin scheme). This can be a remote database on different location. + +Additionally, one can add as many datasource as the email servers under administration. For instance add DB2 as another datasource to manage another remote email server. +Thus, within a single web instance an administrator can manage multiple email server engines on different locations, even on-premise. Remember to enable port 3306 on firewall on remote machines only for the IP running the webadmin web server. + +## Create Superadmin user +cd webadmin +bin/cake users addSuperuser + + +## Final steps +- Configure apache for the new virtual host +- Login as superuser and the password given above (addSuperuser step) +- After login, create datasources under Manage -> Locations and provide the datasource DSN name given in app.php found in 'DSN configuration' section above e.g. Datasource: DB1 +