summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIgor Scheller <igor.scheller@igorshp.de>2018-10-01 18:30:13 +0200
committermsquare <msquare@notrademark.de>2018-10-24 19:16:47 +0200
commit957065bc095c84a7b4737782db80d996e84739d8 (patch)
treeba948754c6382ea5d5fa701143e867a666d8a75f /README.md
parentf35efe01e61fd6d6692d7a76909aaefc93819b4b (diff)
Readme: Bump versions and fix formatting
* Bump required database versions for JSON support and better key handling * Changed PHP version to use a supported one * Fixed migration description * Removed outdated hint for mail config
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 5 insertions, 9 deletions
diff --git a/README.md b/README.md
index c3a650c9..774a450b 100644
--- a/README.md
+++ b/README.md
@@ -2,16 +2,14 @@
[![GPL](https://img.shields.io/github/license/engelsystem/engelsystem.svg?maxAge=2592000)]()
# Engelsystem
-
Please visit https://engelsystem.de for a feature list.
To report bugs use [engelsystem/issues](https://github.com/engelsystem/engelsystem/issues)
## Installation
-
### Requirements:
- * PHP >= 7.0
- * MySQL-Server >= 5.5 or MariaDB-Server >= 5.5
+ * PHP >= 7.1
+ * MySQL-Server >= 5.7.8 or MariaDB-Server >= 10.2.2
* Webserver, i.e. lighttpd, nginx, or Apache
* Node >= 8 (Development/Building only)
* Yarn (Development/Building only)
@@ -62,7 +60,8 @@ To run the unit tests use
vendor/bin/phpunit --testsuite Unit
```
-If a database is configured and the engelsystem is allowed to mess around with some files, you can run feature tests. The tests can potentially delete some database entries, so they should never be run on a production system!
+If a database is configured and the engelsystem is allowed to mess around with some files, you can run feature tests.
+The tests can potentially delete some database entries, so they should never be run on a production system!
```bash
vendor/bin/phpunit --testsuite Feature
# or for unit- and feature tests:
@@ -97,12 +96,9 @@ docker build -f contrib/Dockerfile . -t engelsystem
Import database
```bash
-docker exec -i db_container mysql -u engelsystem -pengelsystem engelsystem < db/install.sql
-docker exec -i db_container mysql -u engelsystem -pengelsystem engelsystem < db/update.sql
+docker exec -it engelsystem bin/migrate
```
-To be able to send mails a relay is needed. Set `SMTPHOST=[mail container]` to configure it.
-
#### Scripts
##### bin/deploy.sh
The `bin/deploy.sh` script can be used to deploy the engelsystem. It uses rsync to deploy the application to a server over ssh.