Aded minimal documentation
This commit is contained in:
parent
8afeeb3fc5
commit
bd8e50493b
17
README.md
17
README.md
@ -1,7 +1,16 @@
|
||||
# Boka2
|
||||
|
||||
There should be a description here
|
||||
|
||||
Additional line
|
||||
Track an inventory of products
|
||||
|
||||
additional line 2
|
||||
## Installation
|
||||
|
||||
* Clone the repo
|
||||
* copy `config.php.example` to `config.php` and set correct values
|
||||
* copy `email-fragments.txt.example` to `email-fragments.txt` and change as necessary
|
||||
* point a webserver to the project root
|
||||
* REMOTE_USER authentication should be configured for the entire application (context path /)
|
||||
* exempt `/cron.php` from authentication
|
||||
* set up a cron job along these lines:
|
||||
```
|
||||
* * * * 1-5 root curl -sS https://example.com/cron.php
|
||||
```
|
||||
|
Loading…
x
Reference in New Issue
Block a user