Commit 7baf62cb authored by Nicolas Lenz's avatar Nicolas Lenz

document PostgreSQL

parent 9e943f82
......@@ -4,7 +4,7 @@
This is the server application for my Warehouse Management System. It is meant to be used with the [fitting voice-controlled Android app](https://git.eisfunke.com/software/wms-app).
This is written in Haskell, using Yesod as web framework and stack as build tool.
This is written in Haskell, using Yesod as web framework and stack as build tool. It requires an PostgreSQL database.
As it has users with passwords, it should *only* be used through a secure HTTPS connection. Locally, the passwords are of course saved securely encrypted (hashed and salted using Argon2, that is).
......@@ -13,6 +13,7 @@ As it has users with passwords, it should *only* be used through a secure HTTPS
1. If you haven't already, [install Stack](https://haskell-lang.org/get-started)
* On POSIX systems, this is usually `curl -sSL https://get.haskellstack.org/ | sh`
2. Enter PostgreSQL user, password, database and host (default is user "wms", password "wms", database "wms" and host "localhost") in config/settings.yml.
2. Build: `stack build` (or install with `stack install` which copies the binaries to `.local/bin`)
3. Start: `stack exec wms-server`.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment