Commit 5c54adcd authored by Nicolas Lenz's avatar Nicolas Lenz

Update build instructions

parent 9356b4dc
......@@ -8,7 +8,19 @@ This is written in Haskell, using Yesod as web framework and stack as build tool
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).
Basic setup instructions can be found at the end of this file.
## Setup
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. Build: `stack build` (or install with `stack install` which copies the binaries to `.local/bin`)
3. Start: `stack exec wms-server`.
This opens the server up at `localhost:3000` which you can then reverse-proxy. Remember to use HTTPS.
Further instructions to deploy the server in other ways (e.g. if you don't want to compile on the server or use FastCGI), see <https://www.yesodweb.com/book/deploying-your-webapp>.
A user can be added with `stack exec wms-server-ctl add-user USERNAME`. It will ask for a password.
## API
......@@ -123,13 +135,3 @@ These are the addresses this server serves:
- `/`
- `GET`: Home page, shows all known containers and has links to the control panel and CSV file.
## Setup
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. Build: `stack build`
3. Start: `stack exec wms-server`
A user can be added with `stack exec wms-server-ctl add-user USERNAME`. It will ask for a password.
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