Commit 2b42ce9e authored by Nicolas Lenz's avatar Nicolas Lenz

API additions documentation, usage with artifacts link

parent 07647e3b
Pipeline #444 passed with stage
in 1 minute and 7 seconds
......@@ -17,6 +17,8 @@ As it has users with passwords, it should *only* be used through a secure HTTPS
2. Build: `stack build` (or install with `stack install` which copies the binaries to `.local/bin`)
3. Start: `stack exec wms-server`.
**Alternatively** you can download the latest prebuilt Linux binaries [here](https://git.eisfunke.com/software/wms-server/-/jobs/artifacts/master/download?job=build). The included config folder contains settings.yaml that can be used just like with the Stack install. Then start the server directly by `./wms-server`, or the ctl app with `./wms-server-ctl`.
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>.
......@@ -44,6 +46,7 @@ These are the addresses this server serves:
]
```
- `PUT`: Sets the location information for a container. The request must contain a body formatted like the output of a GET, see above.
- `DELETE`: Deletes the container and all its allocations to locations.
- `/container`
- `GET`: Gets information about all known containers as JSON list.
Example:
......@@ -78,6 +81,7 @@ These are the addresses this server serves:
]
```
- `PUT`: Sets the information about a location. The request body must be formatted like the output of a GET, see above.
- `DELETE`: Deletes the location and all its allocations to locations.
- `/location`
- `GET`: Gets information about all locations.
Example:
......@@ -136,3 +140,6 @@ These are the addresses this server serves:
- `/`
- `GET`: Home page, shows all known containers and has links to the control panel and CSV file.
- `/version`
- `GET`: Returns version string.
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