From 5dbbbb651737b8a7319b8df9041843986dcc2ce4 Mon Sep 17 00:00:00 2001 From: raphael Date: Mon, 1 Jul 2019 15:13:15 +0200 Subject: [PATCH] add webdav to README --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c347589..8ec9019 100644 --- a/README.md +++ b/README.md @@ -38,16 +38,31 @@ Call your site with GET parameters to change the WhiteboardID or the Username ## Security - AccessToken (Optional) To prevent clients who might know or guess the base URL from abusing the server to upload files and stuff..., you can set an accesstoken at server start. -Without docker: `node server.js --accesstoken="mySecToken"` +Server (Without docker): `node server.js --accesstoken="mySecToken"` -With docker: `docker run -d -e accesstoken="mySecToken" -p 8080:8080 rofl256/whiteboard` +Server (With docker): `docker run -d -e accesstoken="mySecToken" -p 8080:8080 rofl256/whiteboard` -Then set the same token on the client side as well. +Then set the same token on the client side as well: Client (With and without docker): `http://YOURIP:8080?accesstoken=mySecToken&whiteboardid=MYID&username=MYNAME` Done! +## WebDAV (Optional) +This function allow your users to save the whiteboard directly to a webdav server as image. + +Server (Without docker): `node server.js --webdav=true` + +Server (With docker): `docker run -d -e webdav=true -p 8080:8080 rofl256/whiteboard` + +Then set the same parameter on the client side as well: + +Client (With and without docker): `http://YOURIP:8080?webdav=true&whiteboardid=MYID&username=MYNAME` + +Refresh the site and You will notice an extra save button in the top panel. + +Done! + ## Things you may want to know * Whiteboards are gone if you restart the Server, so keep that in mind (or save your whiteboard) * You shoud be able to customize the layout without ever toutching the whiteboard.js (take a look at index.html & main.js) @@ -55,10 +70,10 @@ Done! ## All server run parameters (also docker) * accesstoken => take a look at "Security - AccessToken" for a full explanation * disablesmallestscreen => set this to "true" if you don't want show the "smallest screen" indicator (A dotted gray line) to the users +* webdav => Enable the function to save to a webdav-server (Must also be enabled on the client; Take a look at the webdav section) ## ToDo * Make undo function more reliable on texts -* Add more callbacks for errors and things ... ## Nginx Reverse Proxy configuration Add this to your server part: