Skip to content

iamer/addon-excalidraw

 
 

Repository files navigation

Home Assistant Excalidraw Add-On

logo excalidraw

About

This repository has two Home Assistant add-ons that work together to provide a local instance of excalidraw:

  • The main addon runs the latest release of excalidraw. For more information about excalidraw see their github repository (https://github.com/excalidraw/excalidraw).
  • The companion addon runs an instance of "excalidraw-room" to provide a persistent storage backend.

The main addon build applies two patches to the excalidraw code adapted from https://gitlab.com/kiliandeca/excalidraw-fork

  • Enable runtime configuration of the excalidraw websocket URL.
    • The addon configuration option "VITE_APP_WS_SERVER_URL" can be changed from home assistant UI.
    • This needs to be a URL pointing at where excalidraw is reachable over HTTPS.
    • Excalidraw will try to reach the room server at the same URL under the path "/socket.io/" so that location should be proxied to the room server port.
    • I recommend the excellent nginx proxy manager addon to configure this easily.
  • Enable collaboration when running in an iframe

Screenshots

Screenshot

Installation

  1. Add the repository to Home Assistant supervisor: Supervisor -> Add-on Store -> "Three dots on the right" -> Repositories
  2. Add https://github.com/iamer/addon-excalidraw as additional add-on repository
  3. Install the Excalidraw Addon from the Add-on Store (this could take a while, check the Supervisor logs)
  4. Install the Excalidraw-room Addon if you want to have persistent storage and collaboration
  5. Configure the Excalidraw Addon as described in About

Contribution

Feel free to fork and improve,...

Additional developer notes

Credits

All credits go to the Homeassistant and Excalidraw team and community! The original author of this addon https://github.com/lein1013

About

Homeassistant addon to start a local instance of excalidraw

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Languages

  • Dockerfile 52.3%
  • Shell 47.7%