{"id":27706987,"url":"https://github.com/nordeck/matrix-neoboard","last_synced_at":"2026-02-23T17:41:39.411Z","repository":{"id":166347959,"uuid":"641454250","full_name":"nordeck/matrix-neoboard","owner":"nordeck","description":"A collaborative whiteboard widget for Matrix","archived":false,"fork":false,"pushed_at":"2026-02-21T01:07:51.000Z","size":8025,"stargazers_count":124,"open_issues_count":33,"forks_count":6,"subscribers_count":5,"default_branch":"main","last_synced_at":"2026-02-21T07:08:05.261Z","etag":null,"topics":["element","hacktoberfest","matrix","matrix-widget-api","nordeck","whiteboard"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nordeck.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-05-16T13:56:55.000Z","updated_at":"2026-02-17T06:14:09.000Z","dependencies_parsed_at":"2023-06-09T05:30:14.988Z","dependency_job_id":"1bd1251d-6d18-46d1-a1ee-fc6c9ef9377d","html_url":"https://github.com/nordeck/matrix-neoboard","commit_stats":null,"previous_names":[],"tags_count":45,"template":false,"template_full_name":null,"purl":"pkg:github/nordeck/matrix-neoboard","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nordeck%2Fmatrix-neoboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nordeck%2Fmatrix-neoboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nordeck%2Fmatrix-neoboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nordeck%2Fmatrix-neoboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nordeck","download_url":"https://codeload.github.com/nordeck/matrix-neoboard/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nordeck%2Fmatrix-neoboard/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29749269,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-23T07:44:07.782Z","status":"ssl_error","status_checked_at":"2026-02-23T07:44:07.432Z","response_time":90,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["element","hacktoberfest","matrix","matrix-widget-api","nordeck","whiteboard"],"created_at":"2025-04-26T07:01:01.392Z","updated_at":"2026-02-23T17:41:39.405Z","avatar_url":"https://github.com/nordeck.png","language":"TypeScript","readme":"# NeoBoard\n\n[![CI](https://github.com/nordeck/matrix-neoboard/actions/workflows/ci.yml/badge.svg)](https://github.com/nordeck/matrix-neoboard/actions/workflows/ci.yml)\n[![Matrix](https://img.shields.io/matrix/nordeck%3Amatrix.org)](https://matrix.to/#/#nordeck:matrix.org)\n\nA collaborative whiteboard widget for Element, based on [Matrix](https://matrix.org).\nUse it to collaborate in real-time with your peers, by keeping full control of your data and keep it secure with end-to-end encryption.\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd colspan=\"4\"\u003e\n      \u003cimg src=\"./docs/img/neoboard.png\" alt=\"A screenshot of the NeoBoard showing the drawing board, a list of different slides, and the cursors of the collaborators Alicia and Jim.\"\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\n      \u003cimg src=\"./docs/img/example-kanban.png\" alt=\"A whiteboard showing a Kanban board with three columns: to do, in progress, done.\"\u003e\n    \u003c/td\u003e\n    \u003ctd\u003e\n      \u003cimg src=\"./docs/img/example-leancoffee.png\" alt=\"A whiteboard showing a board to moderate a lean coffee.\"\u003e\n    \u003c/td\u003e\n    \u003ctd\u003e\n      \u003cimg src=\"./docs/img/example-mindmap.png\" alt=\"A whiteboard showing a mindmap to collect ideas.\"\u003e\n    \u003c/td\u003e\n    \u003ctd\u003e\n      \u003cimg src=\"./docs/img/example-swot.png\" alt=\"A whitboard showing an empty SWOT analysis to collect strengths, weaknesses, opportunities, and threats.\"\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\nAll data is stored in the Matrix rooms. Learn more about the architecture in the [Model](./docs/model) or the [Architecture Decision Records](./docs/adrs).\n\n## Usage\n\nNeoBoard is a Matrix widget, which can be added to a chat room to extend the client feature set with a whiteboard.\nCurrently, [Element Web](https://app.element.io), version `1.11.8` or later, is the only known client that supports widgets.\n\n\u003e [!NOTE]\n\u003e Beyond that, NeoBoard supports real time collaboration between users sharing the same chat room, and therefore requires working WebRTC connections between all participants. Most servers including Matrix.org support this, but you can read more about it [here](#important-notes).\n\n\u003e [!IMPORTANT]\n\u003e NeoBoard stores its data in Matrix rooms. Depending on the amount of content on your whiteboard, it needs to send multiple hidden messages to save it. The amount of messages is larger than many servers allow. We therefore currently recommend you use NeoBoard with your own server and a [tweaked configuration](./docs/configuration.md#rate-limiting-settings).\n\n### Demo\n\n[Click here](https://nordeck.github.io/matrix-neoboard) and follow the instructions to see it in action and experience it yourself.\nYou need at least Moderator permissions (power level \u003e50) in the room so it might be a good idea to test it in a new Matrix room at first.\n\nThis is only a demo deployment that is not suited for production use.\nSee the [Deployment](#deployment) section on how you can host the widget on your own.\n\n\u003e 💡 Import the [NeoBoard quick start pack](./docs/NeoBoard%20QuickStart%20Pack.nwb) for some demo content to get started right away.\n\n## Development\n\nDevelopment on the widget happens at [GitHub](https://github.com/nordeck/matrix-neoboard).\n\n### How to Contribute\n\nPlease take a look at our [Contribution Guidelines](https://github.com/nordeck/.github/blob/main/docs/CONTRIBUTING.md).\nCheck the following steps to develop for the widget:\n\n### Requirements\n\nYou need to install Node.js (`\u003e= 20.0.0`, prefer using an LTS version) and run\n`yarn` to work on this package.\nThe minimal Element version to use this widget is `1.11.46`.\nIf you are using `MatrixRTC`, it is recommended to use Synapse with the minimal version `1.127.0`\nthat has delayed events support.\n\n### Dependencies\n\nAfter checkout, run `yarn install` to download the required dependencies\n\n\u003e [!WARNING]\n\u003e Do not use `npm install` when working with this package.\n\n### Configuration\n\nRename the provided `.env.local.default` to `.env.local` and fill it with your configuration.\nFor a list of available options, see [Configuration](./docs/configuration.md).\n\n### Running the Widget Locally\n\nFollow the [instructions to run the widget locally](https://github.com/nordeck/matrix-widget-toolkit/tree/main/example-widget-mui#running-the-widget-locally).\nVisit the widget url follow the further instructions: `http://localhost:5273/` or `https://localhost:5274/` .\n\n### Running with a local version of the matrix-widget-toolkit\n\nIf changes inside matrix-widget-toolkit are required or for debugging purposes,\nyou can clone the repos next to each other and link the packages with `yarn link`:\n\n```\nls\nmatrix-neoboard\nmatrix-widget-toolkit\n```\n\nThen yarn link the required matrix-widget-toolkit packages, for example:\n\n```\ncd matrix-widget-toolkit\nyarn install\ncd packages/api\nyarn link\ncd ../../../matrix-neoboard\nyarn link @matrix-widget-toolkit/api\nyarn install\n```\n\n### Available Scripts\n\nIn the project directory, you can run:\n\n- `yarn dev`: Start the widget for development.\n- `yarn dev:https`: Start the widget for development with a self-signed HTTPS certificate.\n- `yarn build`: Build the production version of the widget.\n- `yarn preview`: Preview a production build of the widget.\n- `yarn preview:https`: Preview a production build of the widget with a self-signed HTTPS certificate.\n- `yarn test`: Watch all files for changes and run tests.\n- `yarn tsc`: Check TypeScript types for errors in the widget.\n- `yarn lint`: Run eslint on the widget.\n- `yarn prettier:write`: Run prettier on all files to format them.\n- `yarn depcheck`: Check for missing or unused dependencies.\n- `yarn deduplicate`: Deduplicate dependencies in the `yarn.lock` file.\n- `yarn changeset`: Generate a changeset that provides a description of a\n  change.\n- `yarn translate`: Update translation files from code.\n- `yarn generate-disclaimer`: Generates license disclaimer and include it in the build output.\n- `yarn docker:build`: Builds a container from the output of `yarn build` and `yarn generate-disclaimer`.\n- `yarn docker:run`: Runs the container and serves the widget at [http://localhost:3000](http://localhost:3000).\n- `yarn clean`: Cleans builds and caches\n- `yarn clean:build`: Cleans builds\n- `yarn clean:cache`: Cleans caches\n\n### Versioning\n\nThis package uses automated versioning.\nEach change should be accompanied by a specification of the impact (`patch`, `minor`, or `major`) and a description of the change.\nUse `yarn changeset` to generate a new changeset for a pull request.\nLearn more in the [`.changeset` folder](./.changeset).\n\nOnce the change is merged to `main`, a “Version Packages” pull request will be created.\nAs soon as the project maintainers merged it, the package will be released and the container is published.\n\n### Architecture Decision Records\n\nWe use [Architecture Decision Records (ADR)s](https://github.com/nordeck/matrix-widget-toolkit/blob/main/docs/adrs/adr001-use-adrs-to-document-decisions.md) to document decisions for our software.\nYou can find them at [`/docs/adrs`](./docs/adrs/).\n\n## Deployment\n\nYon can run the widget using Docker:\n\n```sh\ndocker run --rm -e REACT_APP_HOME_SERVER_URL=https://matrix-client.matrix.org -p 8080:8080 ghcr.io/nordeck/matrix-neoboard-widget:latest\n```\n\nBe sure, that you also read the security notes in the base image [@matrix-widget-toolkit/widget-server](https://github.com/nordeck/matrix-widget-toolkit/tree/main/containers/widget-server) docs.\n\nThe image supports customizing the nginx config by supplying additional config files.\nFor example, this allows running the image in an IPv4-only environment, as demonstrated at \u003chttps://github.com/nordeck/matrix-widget-toolkit/tree/main/containers/widget-server#custom-listen-directive\u003e\n\nWe also provide a [HELM chart](./charts/).\n\nInstall via OCI Registry:\n\n```sh\nhelm install matrix-neoboard-widget oci://ghcr.io/nordeck/charts/matrix-neoboard-widget\n```\n\n### Important notes\n\n**TURN server**\n\nThe real time collaboration features require you to configure TURN servers in your Homeserver.\nWhile it might appear like NeoBoard still works without them, it will be missing some features and other features might start behaving unexpectedly.\nRunning in an environment without TURN is currently not supported.\nThe official matrix.org homeserver will work; see for example how to configure them for [Synapse](https://matrix-org.github.io/synapse/latest/turn-howto.html).\n\n**Rate limiting settings**\n\nFor a good NeoBoard experience we highly recommend to tweak the rate limiting settings as described in the [configuration](./docs/configuration.md#rate-limiting-settings).\nOtherwise users may get stuck in a state where they need to confirm to re-send messages before NeoBoard resumes to work normally after it ran into rate limiting.\n\n## Supply Chain Security\n\nTo ensure transparency and security in our software supply chain, we provide comprehensive Software Bill of Materials (SBOM) reports for this project and signed container images.\n\n### SBOM Reports\n\nWe provide SBOM reports within the widget container and as a release artifact.\n\n- The generated SBOM report is available alongside the hosted widget assets, and can be found at `\u003cDEPLOYMENT-URL\u003e/sbom.spdx.json`, or via the filesystem at `/usr/share/nginx/html/sbom.spdx.json`\n- Each GitHub release has a corresponding image SBOM scan report file attached as a release asset\n\n### Signed Container Images\n\nThe container images releases are signed by [cosign](https://github.com/sigstore/cosign) using identity-based (\"keyless\") signing and transparency.\nExecute the following command to verify the signature of a container image:\n\n```sh\ncosign verify \\\n--certificate-identity-regexp https://github.com/nordeck/matrix-neoboard/.github/workflows/publish-release.yml@refs/tags/v \\\n--certificate-oidc-issuer https://token.actions.githubusercontent.com \\\nghcr.io/nordeck/matrix-neoboard-widget:\u003cversion\u003e | jq\n```\n\nExecute the following command to verify the signature of a chart container image (example for version: `@nordeck/helm-matrix-neoboard-widget-0.2.0`):\n\n```sh\ncosign verify \\\n--certificate-identity-regexp https://github.com/nordeck/matrix-neoboard-widget/.github/workflows/helm-release.yml@refs/tags/@nordeck/helm-matrix-neoboard-widget-0.2.0 \\\n--certificate-oidc-issuer https://token.actions.githubusercontent.com \\\nghcr.io/nordeck/charts/matrix-neoboard-widget:0.2.0 | jq\n```\n\n## Matrix Room Upgrades\n\nThe widget room can be [upgraded](https://matrix.org/docs/communities/administration/#room-upgrades).\nBefore the upgrade, it is strongly recommended to download any whiteboard data by exporting it as NeoBoard file (.nwb).\nAfter the upgrade, the NeoBoard widget needs to be configured in the new room and the .nwb file can be imported.\n\nIf you are using the widget as part of [NeoDateFix](https://github.com/nordeck/matrix-meetings) meetings, then\nplease refer to its [documentation](https://github.com/nordeck/matrix-meetings/blob/main/README.md#matrix-room-upgrades)\nabout room upgrades.\n\nMatrix room version 12 is supported from NeoBoard version [2.3.1](https://github.com/nordeck/matrix-neoboard/releases/tag/%40nordeck%2Fmatrix-neoboard-widget%402.3.1).\n\n## License\n\nThis project is licensed under [APACHE 2.0](./LICENSE).\n\nThe disclaimer for other OSS components can be accessed via the `/NOTICE.txt` endpoint.\nThe list of dependencies and their licenses are also available in a machine readable format at `/usr/share/nginx/html/licenses.json` in the container image.\n\n## Sponsors\n\n\u003cp align=\"center\"\u003e\n   \u003ca href=\"https://www.dphoenixsuite.de/\"\u003e\u003cimg src=\"./docs/logos/dphoenixsuitelogo.svg\" alt=\"dPhoenixSuite\" width=\"20%\"\u003e\u003c/a\u003e\n   \u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\n   \u003ca href=\"https://www.dataport.de/\"\u003e\u003cimg src=\"./docs/logos/dataportlogo.png\" alt=\"Dataport\" width=\"20%\"\u003e\u003c/a\u003e\n   \u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\n   \u003ca href=\"https://www.nordeck.net/\"\u003e\u003cimg src=\"./docs/logos/nordecklogo.png\" alt=\"Nordeck\" width=\"20%\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nThis project is part of the [dPhoenixSuite by Dataport](https://www.dphoenixsuite.de/).\n","funding_links":[],"categories":["Bots"],"sub_categories":["Collaboration"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnordeck%2Fmatrix-neoboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnordeck%2Fmatrix-neoboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnordeck%2Fmatrix-neoboard/lists"}