Comments (6)
Oh, yes, I would love a contribution to the documentation !
Here are the answers to your questions:
How does the data get stored?
The data is stored in json files (one file per board) in the server-data
directory
How to delete the whiteboards once created ?
This is currently not possible, on purpose: since there is no user permissions, we don't want a single person to be able to delete the whole whiteboard.
If you have access to the server, you can simply delete the board's json file in server-data/
.
Is there an API can access to make changes ?
The communication protocol is socket.io, it is quite simple, but I haven't documented it. The messages are simple json messages in the form :
{
"board": "board name",
"data": ...
}
And the data is specific to each tool. For instance, for a rectangle, it is :
{
"type": "rect",
"id": "unique id",
"color": "#71AF32",
"size": 3,
"opacity": 0.3,
"x": x,
"y": y,
"x2": x,
"y2": y
}
You can find the specific format used in each tool directory.
If you have more questions, let me know ! If you want to contribute, you are very welcome !
from whitebophir.
So am I right in thinking to deploy this to our own server we should clone the rep, then build a docker image and deploy that to a container? Linux presumably? Happy to contribute some notes on how to do that if I get a few pointers - new to Docker.
from whitebophir.
I should be really simple, when using docker compose.
Clone the repository
git clone [email protected]:lovasoa/whitebophir.git
cd whitebophir
Running the code in a container (safer)
Choose where to persist the data (optional)
You can edit docker-compose.yml
to choose where you want to persist the data
volumes:
- /home/ophir/whitebophir/server-data:/opt/app/server-data
Here, I chose to persist the data in /home/ophir/whitebophir/server-data
(the directory where I cloned the repo)
Start the service
sudo docker-compose up
This will start wbo on port 80. (You can change the port number in docker-compose.yaml
if you want)
from whitebophir.
Running the code without a container
You can alternatively run the code with node directly, without docker :
npm install
npm start
If you do that, the code is running directly on your machine, without any isolation from the other services. Make sure you do not run another sensitive service on the same host.
from whitebophir.
I also pushed the WBO docker image on docker hub for easier usage:
https://hub.docker.com/repository/docker/lovasoa/wbo
from whitebophir.
@petrk94 I would love if you could give feedback on the documentation I wrote in the README. If you see possible improvements, do not hesitate to suggest them !
from whitebophir.
Related Issues (20)
- [BUG] Selections not resetting properly
- Add Picture in the whiteboard HOT 1
- FOR CREATORS! COMPLAINT ABOUT DISORDER ON whitebophir WBO! HOT 7
- Premission to publish "WBO" app in Umbrel App store HOT 1
- Keyboard Shortcuts HOT 2
- How delete a board? HOT 1
- Note: There is now a Sandstorm package for this app! HOT 4
- Linting and Formatting HOT 5
- Formatting and Add formatting to CI workflow HOT 3
- Implement ESLint to the project and resolve the ESLint errors HOT 13
- Docker WBO KO sur Synology HOT 8
- Run on Public IP Address HOT 1
- Pen/tablet pressure support
- The whiteboard is freezing sometimes if selected items
- After moving the screen, writing renders incorrect.
- From a certain size, the whiteboard becomes too slow to handle. HOT 1
- Is there a way to disable the public board? HOT 2
- Board "pages" HOT 1
- Adding option for default color HOT 1
- Set default tool as ENV or URL-parameter HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from whitebophir.