From 533a075efabb2a8ed28bea16c725787bd32a30dd Mon Sep 17 00:00:00 2001 From: lovasoa Date: Tue, 18 Oct 2022 10:24:29 +0200 Subject: [PATCH] readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b9abca7..717c7f1 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ If you have your own web server, and want to run a private instance of WBO on it ### Running the code in a container (safer) If you use the [docker](https://www.docker.com/) containerization service, you can easily run WBO as a container. -An official docker image for WBO is hosted on dockerhub as [`lovasoa/wbo`](https://hub.docker.com/r/lovasoa/wbo): [![WBO 1M docker pulls](https://img.shields.io/docker/pulls/lovasoa/wbo.svg)](https://hub.docker.com/repository/docker/lovasoa/wbo). +An official docker image for WBO is hosted on dockerhub as [`lovasoa/wbo`](https://hub.docker.com/r/lovasoa/wbo): [![WBO 1M docker pulls](https://img.shields.io/docker/pulls/lovasoa/wbo?style=flat)](https://hub.docker.com/repository/docker/lovasoa/wbo). You can run the following bash command to launch WBO on port 5001, while persisting the boards outside of docker: @@ -81,7 +81,7 @@ If you feel like contributing to this collaborative project, you can [translate ## Authentication -WBO supports authentication with a JWT. This should be passed in as a query with the key `token`, eg, `http://myboard.com/boards/test?token={token}` +WBO supports authentication using [Json Web Tokens](https://jwt.io/introduction). This should be passed in as a query with the key `token`, eg, `http://myboard.com/boards/test?token={token}` The `AUTH_SECRET_KEY` variable in [`configuration.js`](./server/configuration.js) should be filled with the secret key for the JWT.