Setup instructions

.env.example

@@ -1,6 +1,6 @@
-APP_NAME=Laravel
+APP_NAME="VMail Manager"
 APP_ENV=local
-APP_KEY=
+APP_KEY=base64:iYgZqwSB0cUH2P5bCtmijXhpX1nJpn51m7N6Bw21Bqs=
 APP_DEBUG=true
 APP_URL=http://localhost
 

README.md

@@ -42,3 +42,23 @@ This management interface includes the following features
 - Set-up mail accounts per domain
 - Configure aliases per domain - with multiple recipients
 - Portal to have users change their own email password
+
+## Setup
+To setup the system, create a mysql user and database for yorur vmail system
+Then copy ```.env.example``` to ```.env``` and edit the configuration values in there
+
+Then run
+- ```php artisan migrate``` to create the database.
+
+### Recommended server setup
+- Nginx with php-fpm (7.3 or greater)
+- MariaDB or MySQL
+- Redis server for cache
+
+### Create admin account
+To create an account, after setting up the system, go to the homepage and click 'register'
+This creates an unverified account.
+
+To setup this account as admin, do some modifications in the role_users table, to link your user id to the admin role.
+
+_Note: Should update this to have an artisan command or database seed_