Lightweight collaborative Whiteboard / Sketchboard
Go to file
2018-02-09 01:32:34 +01:00
doc add start.png 2018-02-08 23:51:17 +01:00
public add favicon 2018-02-09 01:13:31 +01:00
.gitignore fix drag and drop functions 2018-02-08 23:16:28 +01:00
Dockerfile basic whiteboard with no btns 2018-02-08 17:45:07 +01:00
LICENSE Initial commit 2018-02-08 16:52:49 +01:00
package-lock.json fix socket io connections behind a reverse proxy 2018-02-09 00:45:10 +01:00
package.json fix drag and drop functions 2018-02-08 23:16:28 +01:00
README.md Update README.md 2018-02-09 01:32:34 +01:00
s_whiteboard.js basic whiteboard with no btns 2018-02-08 17:45:07 +01:00
server.js prevent cross site scripting 2018-02-08 23:43:14 +01:00

whiteboard

This is a lightweight NodeJS collaborative Whiteboard/Sketchboard witch can easily be customized...

start

Some Features

  • Showing remote user cursors while drawing
  • Undo function for each user (strg+z as well)
  • Drag & Drop Images to Whiteboard from PC and Browsers
  • Copy & Paste Images from Clipboard
  • Resize, Move & Draw Images to Canvas or Background
  • Save Whiteboard to Image and JSON
  • Draw angle lines by pressing "shift" while drawing (with line tool)
  • Draw square by pressing "shift" while drawing (with rectangle tool)

Install the App

You can run this app with and without docker

Without Docker

  1. install the latest NodeJs
  2. Clone the app
  3. Run npm i inside the folder
  4. Run node server.js
  5. Surf to http://YOURIP:8080

With Docker

  1. docker run -d -p 8080:8080 rofl256/whiteboard
  2. Surf to http://YOURIP:8080

API

Call your site with GET parameters to change the WhiteboardID or the Username

http://YOURIP:8080?whiteboardid=MYID&username=MYNAME

  • whiteboardid => All people with the same ID are drawing on the same board
  • username => The name witch is showing to others while drawing

Things you may want to know

  • Whiteboards are gone if you restart the Server, so keep that in mind (or save your whiteboard)
  • This is just a sample layout to show the functions available
  • You shoud be able to customize without ever toutching the whiteboard.js (take a look at index.html & main.js)

ToDo

  • Add feedback for errors and things ...

Nginx Reverse Proxy configuration

Add this to your server part:

    location /whiteboard/ {
        proxy_set_header HOST $host;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection upgrade;
        proxy_pass http://YOURIP:8080/;
    }

To run it at /whiteboard. Don't forget to change -> YOURIP!

Nextcloud integration

  1. Install this app on your server
  2. Enable and go to "external sites" on your Nextcloud
  3. Add Link to your server: https://YOURIP/whiteboard/?whiteboardid=WHITEBOARDNAME&username={uid} You can give each group its own whiteboard by changeing the WHITEBOARDNAME in the URL if you want.

Note: You might have to serv the app with https (If your nextcloud server runs https). To do so, its recommend to run this app behind a reverse proxy. (as shown above)

___ MIT License ___