Mirrors/whitebophir
2
0
Fork 0
mirror of https://github.com/lovasoa/whitebophir synced 2024-09-20 06:12:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

readme

Browse source
This commit is contained in:
lovasoa 2022-10-18 10:24:29 +02:00
parent 0a3cc81584
commit 533a075efa
No known key found for this signature in database
GPG key ID: AC8DB8E033B44AB8
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -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) ### 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. 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: 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 ## 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. The `AUTH_SECRET_KEY` variable in [`configuration.js`](./server/configuration.js) should be filled with the secret key for the JWT.