Skip to content

FoxxMD/tldraw-selfhosted

Repository files navigation

tldraw for selfhosting

License: MIT Docker Pulls

A minimal implementation of tldraw based on the starter/templates simple-sever and sync-cloudflare.

This implementation offers:

  • basic whiteboard with tldraw sync for multiplayer/realtime collaboration
  • Unique Rooms, IE mydomain.com/my-tldraw-room, backed by file storage
  • User uploads backed by file storage
  • A development environment with devcontainer
  • All assets selfhosted (no cdn)
  • Docker image and docker compose example for quick deployment

Usage and tldraw License

Docker image available at

docker.io/foxxmd/tldraw:latest

Use the compose.yaml docker compose file to start tldraw:

docker compose up -d

tldraw will be served at http://localhost:5858

Production and tldraw License

When deployed on localhost with the above published image, or when developing with devcontainer, this implementation is usable.

If you deploy tldraw-selfhosted to an SSL-enabled TLD (https://mydomain.com) then you will need to build it with a valid tldraw license. Hobby licenses, which are free, are available by applying on tldraw's site.

To build the image with your license use compose.build.yaml and provide your license to the build-arg VITE_TLDRAW_LICENSE_KEY.

git clone https://github.com/FoxxMD/tldraw-selfhosted tldraw-selfhosted
cd tldraw-selfhosted
# fill in VITE_TLDRAW_LICENSE_KEY in compose.build.yaml, then...
docker compose -f compose.build.yaml build
docker compose -f compose.build.yaml up -d

License

This project is provided under the MIT license found here. The tldraw SDK is provided under the tldraw license.

About

A dockerized, selfhostable version of multiplayer tldraw

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages