WebDev
/
VersaWhiteboard
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

add webdav to README

This commit is contained in:
raphael 2019-07-01 15:13:15 +02:00
parent 9f7c780e16
commit 5dbbbb6517
1 changed files with 19 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -38,16 +38,31 @@ Call your site with GET parameters to change the WhiteboardID or the Username
## Security - AccessToken (Optional) ## 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. 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.
<b>Without docker:</b> `node server.js --accesstoken="mySecToken"` <b>Server (Without docker):</b> `node server.js --accesstoken="mySecToken"`
<b>With docker:</b> `docker run -d -e accesstoken="mySecToken" -p 8080:8080 rofl256/whiteboard` <b>Server (With docker):</b> `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:
<b>Client (With and without docker):</b> `http://YOURIP:8080?accesstoken=mySecToken&whiteboardid=MYID&username=MYNAME` <b>Client (With and without docker):</b> `http://YOURIP:8080?accesstoken=mySecToken&whiteboardid=MYID&username=MYNAME`
Done! Done!
## WebDAV (Optional)
This function allow your users to save the whiteboard directly to a webdav server as image.
<b>Server (Without docker):</b> `node server.js --webdav=true`
<b>Server (With docker):</b> `docker run -d -e webdav=true -p 8080:8080 rofl256/whiteboard`
Then set the same parameter on the client side as well:
<b>Client (With and without docker):</b> `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 ## Things you may want to know
* Whiteboards are gone if you restart the Server, so keep that in mind (or save your whiteboard) * 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) * 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) ## All server run parameters (also docker)
* accesstoken => take a look at "Security - AccessToken" for a full explanation * 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 * 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 ## ToDo
* Make undo function more reliable on texts * Make undo function more reliable on texts
* Add more callbacks for errors and things ...
## Nginx Reverse Proxy configuration ## Nginx Reverse Proxy configuration
Add this to your server part: Add this to your server part: