From 3a9344c53517598a60c8945251210149878683a5 Mon Sep 17 00:00:00 2001 From: Skylar Ittner Date: Thu, 26 Jul 2018 09:49:59 -0600 Subject: [PATCH] Update installation instructions, add upgrade instructions (issue #11) --- README.md | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index a23fd98..b7416c7 100644 --- a/README.md +++ b/README.md @@ -10,19 +10,24 @@ https://netsyms.biz/apps/accounthub Installing ---------- -*We're working on a nice script to install it automatically, but until then...* - -0. Setup a LAMP server with additional PHP extensions mbstring, zip, ldap, gd, imagick +0. Setup a LAMP server with PHP 7.2, including PHP extensions mbstring, zip, gd, and imagick 1. Copy `settings.template.php` to `settings.php` 2. Import `database.sql` into your database server 3. Edit `settings.php` and fill in your DB info -4. Setup LDAP auth, or set "LDAP_ENABLED" to FALSE -5. Set the URL of the install -6. Set the API and HOME values for TaskFloor, Inventory (BinStack), QwikClock, and in the "EXTERNAL_APPS" setting -7. Remove any apps you aren't installing from "EXTERNAL_APPS" -8. Setup the email settings to receive alerts you configure later in ManagePanel -9. Run `composer install` (or `composer.phar install`) to install dependency libraries -10. Edit the database table `apikeys` and add some API keys for the other apps to use -11. From a web browser, visit `http://apps/url` (or whatever your setup is). If you did everything right, you should see a login screen. -12. Now go to `http://apps/url/setup.php` and create an admin account. -13. Install [ManagePanel](https://source.netsyms.com/Business/ManagePanel) to setup additional user accounts. \ No newline at end of file +4. Set the URL of the install +5. Setup "EXTERNAL_APPS" with specifics for your install. +6. Setup the email settings to receive alerts you configure later in ManagePanel +7. Run `composer install` (or `composer.phar install`) to install dependency libraries +8. Edit the database table `apikeys` and add some API keys for the other apps to use +9. From a web browser, visit `http://apps/url` (or whatever your setup is). If you did everything right, you should see a login screen. +10. Now go to `http://apps/url/setup.php` and create an admin account. +11. Install [ManagePanel](https://source.netsyms.com/Business/ManagePanel) to setup additional user accounts. + + +Upgrading +--------- + +1. Run `git pull` or otherwise update the code +2. Run `composer install` to update dependencies +3. Execute the SQL scripts in `database_upgrade` to take you from your current version to the latest version +4. Rewrite your `settings.php` based on the new `settings.template.php`