Skip to content

Commit

Permalink
#32 : README updates for REST API
Browse files Browse the repository at this point in the history
  • Loading branch information
gazbert committed Apr 4, 2020
1 parent 550c604 commit 4aa20fd
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -549,17 +549,19 @@ It has role based access control
([RBAC](https://en.wikipedia.org/wiki/Role-based_access_control)): Users can view config and the
logs, but only administrators can update config and restart the bot.

It is secured using [JWT](https://jwt.io/) over [TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security).
It is secured using [JWT](https://jwt.io/) and has [TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security)
support for Production environments.

You can view the [Swagger](https://swagger.io/tools/swagger-ui/) docs at:
[http://localhost:8080/swagger-ui.html](http://localhost:8080/swagger-ui.html) once you've configured
and started the bot.

#### Configuration
The REST API is disabled by default to prevent accidental exposure of unencrypted traffic over public networks.
To enable it, you need to change the `server.port` in the
[./config/application.properties](./config/application.properties) from '-1' to the port you want
the bot to listen on - see the _[TLS](#tls)_ section below if you plan on accessing the REST API over a public network.
The REST API listens for plain HTTP traffic on port `8080` by default - you can change the
`server.port` in the [./config/application.properties](./config/application.properties) file.

**IMPORTANT:** The bot must be configured to use TLS if you plan on accessing the REST API over a
public network - see the _[TLS](#tls)_ section below.

You _must_ change the `bxbot.restapi.jwt.secret` value in the
[./config/application.properties](./config/application.properties) before using the REST API over a public network.
Expand Down

0 comments on commit 4aa20fd

Please sign in to comment.