Commit 31649111 authored by Corey O'Connor's avatar Corey O'Connor
Browse files

readme tweaks

parent 9284504a
......@@ -49,7 +49,7 @@ curl -L -o glngn-server-assembly.jar https://glngn-server-releases.s3.amazonaws.
## Command Help
Run using java and pass `--help` to see usage information:
Run using `java` and pass `--help` to see usage information:
```bash
$ java -jar ./glngn-server-assembly.jar --help
......@@ -80,8 +80,8 @@ Use of this software is agreement with the included Application Developer Licens
## Running
Note: For consistency within the docs, the port 10000 is requested using `--port 10000`. If this option is
not provided a free port will automatically be selected.
Note: For consistency the docs always use port 10000. This is requested using the `--port 10000`
command line argument.
Let's run a server configured to store data at `./starter.state`. In a terminal session:
......@@ -94,22 +94,22 @@ INFO use of this software is agreement with the included Developer License.
INFO glngn.server.host.ServerApp$ - application is listening at http://localhost:10000
```
At this point the standalone server is initialized and ready.
The standalone server is initialized and ready.
See [docs/Deep Dives](https://gitlab.com/glngn/glngn-server-examples/blob/master/docs/DeepDives.md)
for more details on what happened.
for technical details on the initialization process.
Hit control-C, or TERM the process (there is only one), to shut down the server. This will take a bit
for a nice, coordinated shutdown. Which is preferred. That said, the server is configured to attempt
recovery from sudden terminations. Such as killing a container in a kubernetes cluster.
for a nice, coordinated shutdown.
## Usage
The glngn server provides a REST API with an [OpenAPI](https://www.openapis.org/) specification.
This API supports the built-in features of glngn server as well as any additional features added
by extensions.
This API supports the built-in features of glngn server as well as any additional features added by
extensions.
If you are looking for a GUI for glngn server [please let us know](mailto:support@dogheadbone.com).
This guide walks through the API using `curl`. If you are looking for a GUI or integration with
another HTTP client [please let us know](mailto:support@dogheadbone.com).
### OpenAPI schema
......
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