From eae45b56238345a8494b61a11a1a46245f099b70 Mon Sep 17 00:00:00 2001 From: pmkuipers Date: Sat, 23 May 2020 15:28:46 +0200 Subject: [PATCH] Setup instructions --- .env.example | 4 ++-- README.md | 20 ++++++++++++++++++++ 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/.env.example b/.env.example index ac74863..a9c1816 100644 --- a/.env.example +++ b/.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 diff --git a/README.md b/README.md index 94ea534..0fb3b63 100644 --- a/README.md +++ b/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_ \ No newline at end of file