Excaliself

io.github.maciekzygmunt由 GitHub 账号 maciekzygmunt 发布v0.9.0更新于 Nov 7, 2026

Find, read, create, edit, and organize Excalidraw drawings in your self-hosted Excaliself instance.

已验证Streamable HTTP可网页运行效率与工作流知识与记忆媒体与设计

概览

AI 生成的概览

将 AI 助手连接到自托管的 Excaliself 白板,使其能查找、读取、创建 Excalidraw 绘图并提交修改建议。

可以做什么
  • 列出或搜索绘图与文件夹,并显示所属空间和文件夹
  • 以描述形式读取绘图中的图形、文字和箭头连接关系,而非原始 JSON
  • 在私人空间或团队空间中创建绘图,可放入文件夹,内容来自简单图形与箭头或 Mermaid 流程图
  • 对绘图的图形、文字和箭头提出修改建议,并查询修改是否已被应用
  • 创建文件夹,并在文件夹之间或空间顶层移动绘图
  • 将绘图和文件夹移入回收站,或从回收站恢复
适用场景
适合团队把图表存放在自托管 Excaliself 实例中,并希望助手总结已有绘图、起草新绘图,或提出由人在画布上确认的修改建议时使用。
运行要求
需要一个可通过 HTTPS 访问的 Excaliself 实例,端点为 /api/mcp。客户端通过 OAuth(Claude.ai)或在设置中创建的访问令牌登录,并以 Authorization: Bearer 请求头发送。Claude Desktop 需借助 mcp-remote 和 Node。实例本身不需要 LLM API 密钥。
安装前请注意
令牌或已连接的应用以登录用户身份行事:能看到该用户可见的内容,能将其可删除的内容移入回收站,并可创建绘图和文件夹、移动绘图。对绘图内容的修改需有人在画布上点击 Apply 才生效,且不会永久删除(回收站保留 30 天)。可随时在设置中撤销令牌或断开应用。OAuth 客户端要求实例可从公网通过 HTTPS 访问。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Excaliself,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Web executable,通过 Streamable HTTP。 远程服务在工作区中配置后即可从网页运行时运行。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

[图片]

Excaliself

Your team's whiteboard, on your server.
The Excalidraw canvas in a small self-hosted app: live collaboration, a shared team space, folders, and search, with every drawing stored in your own Postgres.

Website · Docs · 简体中文 · X

[Excaliself home screen in the light theme: a sidebar with starred drawings and folders next to a grid of drawing previews] [The same home screen in the dark theme]

[Two browsers edit one drawing: a box drawn on the left appears live on the right, an arrow drawn on the right appears on the left, and after a reload every change is still there]

Try it in 10 seconds

bash
docker run --rm -p 127.0.0.1:3000:3000 -e PREVIEW_MODE=true ghcr.io/maciekzygmunt/excaliself

Open http://localhost:3000/preview/login to sign in as the admin, with example drawings. To test live collaboration, open http://localhost:3000/preview/login?account=new in a second browser: it signs in as a new member.

Data lives in memory and is gone when the container stops. For real use, see Deploy.

Features

  • The full Excalidraw editor, with auto-save. Images pasted into a drawing are stored too.
  • Live collaboration. Share a drawing by link and edit it together in real time, with live cursors and follow mode. Links can be for members only or for anyone, including guests without an account.
  • Team space. A shared space every member can see and edit, next to each member's private space. Team drawings are always live.
  • Team library. One Library panel of shapes and icons for the whole team, saved on the server and updated live. Libraries from libraries.excalidraw.com install into it.
  • Folders, stars, and recents. Nest folders and drag drawings between them in the sidebar.
  • Search by title and by the text inside drawings, in the gallery and the command palette (⌘K / Ctrl K), which also runs actions.
  • Import from Excalidraw+ (beta). Bring your scenes, collections, and images over with an Excalidraw+ API key (Settings → Import).
  • Drop files in. Drag .excalidraw files (or .png/.svg exports with the scene) from your computer onto a folder in the sidebar.
  • Trash with restore. Deleted items are purged automatically after 30 days.
  • Invite-only accounts. The first visitor creates the admin account; everyone else joins by invite link.
  • Connect your AI client. Claude.ai, Claude Code, Claude Desktop, and other MCP clients can find, read, and create drawings, propose changes to them, and move them to the trash. A change waits on the canvas until you click Apply, and then everyone in the drawing sees it live. Clients sign in with OAuth or a personal access token. The instance needs no LLM API key.
  • Single sign-on with Google Workspace, Microsoft Entra ID, or any OIDC provider (Okta, Authentik, Keycloak). People from your email domains join on their first sign-in, with no invite.
  • Admin tools under Settings: manage members and roles, create password-reset links, and see instance stats.
  • Light and dark themes, with an optional separate theme for the canvas.

Deploy

Both paths run the app and its Postgres database together from one compose file. They pull the prebuilt image ghcr.io/maciekzygmunt/excaliself (amd64 and arm64), so nothing is built on your server. latest is the newest release. The app applies database migrations when it starts, so updating is a redeploy.

Docker Compose

bash
mkdir excaliself && cd excaliselfcurl -fsSLO https://raw.githubusercontent.com/maciekzygmunt/excaliself/main/docker-compose.yamlcurl -fsSL -o .env https://raw.githubusercontent.com/maciekzygmunt/excaliself/main/.env.example# set POSTGRES_PASSWORD, BETTER_AUTH_SECRET, and BASE_URL in .envdocker compose up -d

Open BASE_URL (default http://localhost:3000). The first visit takes you to /setup to create the admin account. Postgres is not published on the host. Put a reverse proxy with HTTPS in front of port 3000 for anything public.

To update, run docker compose pull && docker compose up -d. To pin a release, set EXCALISELF_VERSION (e.g. 1.0.0) in .env. To build the image from source instead (needs about 4 GB of RAM), clone the repo and run docker compose -f docker-compose.yaml -f docker-compose.build.yaml up -d --build. The docs have the details.

Coolify

  1. Add a new resource from the public repository https://github.com/maciekzygmunt/excaliself, branch main.
  2. Choose the Docker Compose build pack and set Docker Compose Location to /docker-compose.coolify.yaml.
  3. Click Deploy.

Coolify creates the database, generates the secrets, and assigns a domain, so there is nothing to configure. If your server has no wildcard domain, first set a domain on the excaliself service with the container port, e.g. https://draw.example.com:3000. Open the domain to create the admin account. To pin a release instead of latest, set EXCALISELF_VERSION (e.g. 1.0.0) in the resource's environment variables. Drawings live in the pgdata volume and survive redeploys.

Configuration

Docker Compose reads these from .env. Coolify sets them for you.

VariableRequiredDescription
POSTGRES_PASSWORDYesPassword for the bundled Postgres. Use hex (openssl rand -hex 24): it goes into a connection URL
BETTER_AUTH_SECRETYesSession signing secret, at least 32 characters (openssl rand -base64 32)
BASE_URLYes in productionPublic URL of the instance (default http://localhost:3000)
EXCALISELF_VERSIONNoImage tag to run: latest (default), a release like 1.0.0 or 1.0, or main
EXCALISELF_PORTNoHost port for the app (default 3000). 127.0.0.1:3000 keeps it local to a reverse proxy
POSTGRES_USER, POSTGRES_DBNoBundled Postgres user and database (default excaliself)
GOOGLE_*, MICROSOFT_*, OIDC_*, SSO_ALLOWED_DOMAINSNoSingle sign-on. See Single sign-on
PREVIEW_MODENotrue runs a throwaway instance for a pull request preview: an in-memory PGlite instead of Postgres, seeded with an admin and example drawings. It ignores DATABASE_URL and BASE_URL and makes BETTER_AUTH_SECRET optional. /preview/login signs in as the admin ([email protected] / preview-password), /preview/login?account=new as a new member. Data is lost on restart. See PR previews
PREVIEW_HOSTSWith PREVIEW_MODE behind a domainComma-separated hosts a preview answers on, e.g. *.draw.example.com. Auth refuses other hosts; localhost always works

GET /api/health returns 200 when the app is up and can reach Postgres.

If the only admin loses their password, see Recover admin access.

Connect an AI client (MCP)

Excaliself has an MCP server at /api/mcp. Your AI client brings the model, so the instance needs no LLM API key.

Claude.ai (web, desktop, and mobile) signs in with OAuth, with no token. In Claude, open Settings, then Connectors, click Add custom connector, and enter https://<your instance>/api/mcp. Then sign in to Excaliself and click Allow. The instance must be reachable from the public internet over HTTPS.

Other clients use an access token:

  1. In Excaliself, open Settings, then MCP, and click New token. Copy the token: you see it only once.
  2. Add the server to your client, with your instance's URL and the token.

Claude Code (the token dialog shows this command filled in):

bash
claude mcp add --transport http excaliself https://draw.example.com/api/mcp \  --header "Authorization: Bearer exs_..."

Claude Desktop cannot send a token to a remote server itself, so it connects through mcp-remote, which needs Node. Open Settings, then Developer, then Edit Config, add this to claude_desktop_config.json, and restart Claude Desktop:

json
{  "mcpServers": {    "excaliself": {      "command": "npx",      "args": [        "-y",        "mcp-remote",        "https://draw.example.com/api/mcp",        "--header",        "Authorization:${AUTH_HEADER}"      ],      "env": { "AUTH_HEADER": "Bearer exs_..." }    }  }}

Other clients that use Streamable HTTP: the URL is https://<your instance>/api/mcp. A client that supports OAuth with dynamic client registration signs in by itself. Otherwise, send the header Authorization: Bearer <token>.

The tools:

  • list_drawings, search_drawings, and list_folders find drawings, with their space and folder.
  • read_drawing describes a drawing: its shapes, text, and what the arrows connect. It does not send the raw Excalidraw JSON.
  • create_drawing makes a new drawing in your private space or in Team, optionally in a folder, from simple shapes and arrows or a Mermaid flowchart.
  • edit_drawing proposes a change to a drawing: shapes, text, and arrows to add, change, or remove. Nothing changes until you click Apply on the drawing. get_drawing_edit tells the client whether you applied it.
  • create_folder makes a folder in your private space or in Team, optionally inside another folder.
  • move_drawing moves a drawing into a folder, or to the top of its space. A drawing cannot move between your private space and Team.
  • trash_drawing and trash_folder move a drawing, or a folder with everything in it, to the trash. restore_drawing and restore_folder take them out again.

A token or a connected app acts as you: it sees what you see, and it can trash what you can trash. It can create drawings and folders, and move drawings between folders. It cannot change what is in a drawing until you click Apply, and it cannot delete anything for good: trashed items stay in Trash for 30 days. Revoke a token or disconnect an app under Settings at any time. When an admin deletes a member, that member's tokens and apps stop working.

Stack

TanStack Start · React 19 · Better Auth · Postgres + Drizzle · Tailwind CSS 4 + shadcn/ui on Base UI · @excalidraw/excalidraw

Local development

Requires Node 22, pnpm, and Docker.

bash
pnpm installcp .env.dev.example .env                           # works as-isdocker compose -f docker-compose.dev.yaml up -d    # Postgres on 127.0.0.1:5432pnpm dev                                           # http://localhost:3000

pnpm dev:preview needs no Postgres and no .env: it runs in preview mode (see PREVIEW_MODE above). Open /preview/login.

pnpm test, pnpm typecheck, and pnpm lint run the checks. pnpm db:generate creates a migration after a schema change. Releases are cut from git tags; see docs/releasing.md.

Sponsors

Excaliself is free and MIT. If your team uses it, sponsoring pays for the time that goes into fixes and releases.

License

MIT. There is no promise of support or reviews for contributions, so feel free to fork it and make it yours.

Built on Excalidraw, MIT © Excalidraw. Excaliself is not affiliated with Excalidraw. "Excalidraw" is a trademark of its owner; this project uses the open-source @excalidraw/excalidraw package.

来源:README.md,提交 318d4d4

工具

0
SourceWeft 尚未读取此服务器的工具。

版本历史

1
  1. v0.9.0最新Nov 7, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通必需25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式必需10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分