[READ-ONLY] Mirror of https://github.com/FoxxMD/tldraw-selfhosted. A dockerized, selfhostable version of multiplayer tldraw
docker
tldraw
whiteboard
update readme
+16
-21
+16
-21
README.md
+16
-21
README.md
···
1
-
# tldraw sync, simple Node/Bun server example
1
+
# tldraw for selfhosting
2
2
3
-
This is a simple example of a backend for [tldraw sync](https://tldraw.dev/docs/sync) with a Node or Bun server.
3
+
A minimal implementation of [tldraw](https://tldraw.dev) based on the starter/templates [simple-sever](https://github.com/tldraw/tldraw/tree/main/templates/simple-server-example) and [sync-cloudflare](https://github.com/tldraw/tldraw/tree/main/templates/sync-cloudflare).
4
4
5
-
Run `yarn dev-node` or `yarn dev-bun` in this folder to start the server + client.
5
+
This implementation offers:
6
6
7
-
For a production-ready example specific to Cloudflare, see /templates/sync-cloudflare.
7
+
* basic whiteboard with [tldraw sync](https://tldraw.dev/docs/sync) for multiplayer/realtime collaboration
8
+
* Unique Rooms, IE `mydomain.com/my-tldraw-room`, backed by file storage
9
+
* User uploads backed by file storage
10
+
* A development environment with devcontainer
11
+
* All assets selfhosted (no cdn)
12
+
* Docker image and docker compose example for quick deployment
8
13
9
-
## License
14
+
## Usage and tldraw License
10
15
11
-
This project is provided under the MIT license found [here](https://github.com/tldraw/tldraw/blob/main/apps/simple-server-example/LICENSE.md). The tldraw SDK is provided under the [tldraw license](https://github.com/tldraw/tldraw/blob/main/LICENSE.md).
16
+
When deployed on `localhost`, or when developing, this implementation is usable.
12
17
13
-
## Trademarks
18
+
If you deploy this to a valid TLD (`mydomain.com`) **you will need to provide a [license](https://tldraw.dev/community/license).** Hobby licenses, which are free, are available with application.
14
19
15
-
Copyright (c) 2024-present tldraw Inc. The tldraw name and logo are trademarks of tldraw. Please see our [trademark guidelines](https://github.com/tldraw/tldraw/blob/main/TRADEMARKS.md) for info on acceptable usage.
16
-
17
-
## Distributions
18
-
19
-
You can find tldraw on npm [here](https://www.npmjs.com/package/@tldraw/tldraw?activeTab=versions).
20
-
21
-
## Contribution
22
-
23
-
Please see our [contributing guide](https://github.com/tldraw/tldraw/blob/main/CONTRIBUTING.md). Found a bug? Please [submit an issue](https://github.com/tldraw/tldraw/issues/new).
20
+
To include your license you will need to build the image yourself.
24
21
25
-
## Community
22
+
TODO: Add the build-arg `VITE_TLDRAW_LICENSE_KEY` or fill in using compose.yaml, then build.
26
23
27
-
Have questions, comments or feedback? [Join our discord](https://discord.tldraw.com/?utm_source=github&utm_medium=readme&utm_campaign=sociallink). For the latest news and release notes, visit [tldraw.dev](https://tldraw.dev).
24
+
## License
28
25
29
-
## Contact
30
-
31
-
Find us on Twitter/X at [@tldraw](https://twitter.com/tldraw).
26
+
This project is provided under the MIT license found [here](https://github.com/tldraw/tldraw/blob/main/apps/simple-server-example/LICENSE.md). The tldraw SDK is provided under the [tldraw license](https://github.com/tldraw/tldraw/blob/main/LICENSE.md).