doory README

项目的 README,来自 github.com/shaongitbd/doory。合并为一个 markdown 文件:README.md。

Doory: the open-source Canva alternative

Doory

Doory is a design editor that runs in the browser: posters, social posts, stories, slides, invitations, resumes, thumbnails and business cards. You start from a template or a blank page, edit everything on it, and export PNG, JPG, SVG, PDF, MP4 or GIF. There is no paid plan, you don't need an account to start, and you can run it on your own server with Docker or without it.

It is a young project: the editor is complete, the template library is small (ten starter templates), and bug reports are very welcome.

Opening the sale post template from the gallery, changing the headline and the discount, and opening the Share menu

What it can do

The editor with the sale post template open and the Text panel beside it Editing. Tools sit in a rail on the left and open as panels; the toolbar above the page changes with what you select. The Animate panel with enter animations Animation. Enter, exit and emphasis animations, page transitions, music and sound effects. Present it, or export it as a video or GIF.
The Layers panel with its right-click menu Layers. Rename, lock, hide, group and reorder anything, or right-click it to copy, duplicate and arrange. The Share menu with sharing, downloads and presenting Share and export. One menu for share links, downloads and presenting. Downloads are made in the browser; print PDFs can have bleed and crop marks.
Text Headings, curved text, effects, font pairings, lists, an open-licensed font catalogue and your own fonts
Elements Shapes, lines and arrows, about 27,500 icons, emoji and illustrations, stickers, QR codes
Photos Upload, crop, masks and filters, background removal that runs in the browser, 2×–4× upscaling with a pure-code resampler, stock photo search with an Unsplash or Pexels key
Layout Layers, groups, alignment guides, snapping, rulers, several pages per design (each its own size), resize to another format
Motion and sound 27 enter and exit animations, 12 emphasis animations, 16 page transitions, 24 music loops and 88 sound effects (CC0), Freesound search with a key (CC0 by default), voiceover recording
Present Present mode with speaker notes, timing, auto-advance and a second presenter window
Together Share links that view, comment or edit (with an optional password), pinned comments, version history, real-time co-editing
Brand Brand kits with your colours, fonts and logos
Export PNG, JPG, SVG, PDF, MP4, WebM and GIF
Accessibility High-contrast mode with darker text, borders and focus rings, following your device setting or switched in the editor's View menu or in Settings

Templates

The ten starter templates: a tour poster, an event story, a sale post, a pitch deck, a grand opening flyer, a wedding invitation, a YouTube thumbnail, a resume, a quote post and a business card

Ten starter templates ship with Doory. Each one follows the layout of the best-selling templates in its category, uses open-licensed fonts and, where it has a photo, a CC0 one. Everything on them can be edited. Admins can add more in the admin site.

The template gallery with category filters

Self-host it

cp .env.example .env     # set DJANGO_SECRET_KEY (openssl rand -base64 48) and POSTGRES_PASSWORD
docker compose up -d --build
docker compose exec api python manage.py createsuperuser   # your admin account; nothing creates one for you

Open http://localhost:8080 and start designing. A new site starts empty, so next add the starter content (templates, fonts, icons, audio).

The documentation covers the rest:

Use it from an AI assistant (MCP)

Doory runs a Model Context Protocol server at /mcp on your domain, so Claude, Cursor and other MCP clients can create and edit your designs: "make a 1080 x 1350 poster for our summer sale with the brand colours", "translate the headlines on every page", "move the logo to the bottom right".

It's off by default. To turn it on, connect a client and see what assistants can do, read docs/self-hosting/mcp.md.

Templates can be filled by field key, from an assistant (fill_design, bulk_fill) or from the REST API (POST /api/v1/designs/{id}/fill/ and /bulk-fill/, one new design per row, at most BULK_FILL_MAX_ROWS). On REST each bulk row counts against the bulk_fill rate (120/min), and over MCP against MCP_CALLS_PER_MINUTE; each new image URL counts against the bulk_fill_images rate (300/min, instead of the upload rate) and each exported image against the export rate. A row over the limit reports its error and the others go on. Image values may be public https URLs, which the server copies into your uploads while URL_IMAGE_UPLOADS is on (the default; set it to false to turn off URL images for the assistant and the API alike). Many URL images or exports make one long request, so lower BULK_FILL_MAX_ROWS if requests hit the worker timeout.

FAQ

Is it really free?
Yes. Doory has no paid plan, no locked features and no ads.
Do I need an account?
No. Guests design straight away and their work is saved in the browser. An account keeps designs in the cloud, lets you share them and use brand kits; signing up moves your guest designs over in one step.
Can I use it for my business or host it for my users?
Yes, as long as you credit the author as the licence asks: keep the licence and NOTICE with it and show the credit in the running app. See License and credit.
Where are my designs stored?
Guest designs and their images live in the browser on that device. Signed-in designs are stored on the server that runs Doory: yours, if you self-host. Uploads can go to a local volume or to S3-compatible storage.

Built with

React 19, TypeScript, Vite, Fabric.js, Yjs and Zustand in the browser; Django 5, Django REST Framework, Channels and PostgreSQL on the server; Docker Compose with nginx, optional Redis and S3-compatible storage.

Contributing

Bug reports, ideas and pull requests are welcome. Open an issue to report a bug or suggest a feature. For a security problem, please report it privately through the repository's Security tab instead. Before opening a pull request, read CONTRIBUTING.md, including the rule for updating the docs.

License and credit

Doory is released under the Attribution Assurance License. You may use, change and redistribute it, including commercially, but you must credit the author: keep the licence and NOTICE with it, and display this credit prominently in the running app:

Doory by Siam, creator and maintainer of Doory, https://github.com/shaongitbd/doory

The copyright is held by Siam and the contributors listed in AUTHORS.md.

The licence text is GPG-signed by Siam, as the licence asks. To check it: gpg --import licenses/siam-gpg.asc && gpg --verify LICENSE. The key's fingerprint is 3255 3D6C 37CF 387A 36FF D6BB FEB1 0669 1898 A504, and the same key is published at https://github.com/shaongitbd.gpg.

Third-party software, fonts and content keep their own licences; see THIRD_PARTY.md.



Made with care by Siam and the Doory bunny.

doory (shaongitbd/doory)

正在搜索数据库…

2.8K ·GitHub
这是什么?Doory 是一个开源的浏览器设计编辑器,也是 Canva 的替代品,可用于制作海报、社交媒体帖子、幻灯片、简历、邀请函、缩略图和名片,支持动画、图层以及多种格式导出。
我该如何自行托管?Doory 由三部分组成:Django API、实时协同编辑服务器和静态网页应用。你可以用 Docker Compose 启动它们,也可以在 Debian/Ubuntu 上通过 nginx 和 systemd 手动部署。
不使用 Docker 运行它需要什么?不使用 Docker 时,你需要 Python 3.12、Node.js 22(仅用于构建网页应用)和 PostgreSQL;服务器端的 PDF 导出还需要通过 Playwright 安装无界面模式的 Chromium。
模板库已经填充完整了吗?还没有。Doory 是一个较新的项目,编辑器本身已经完成,但默认只提供十个入门模板;管理员可以通过管理后台添加更多模板。
我的设计作品存储在哪里?访客的设计及其图片保存在你设备的浏览器中,永远不会离开你的设备;只有登录后创建的设计才会存储在你的服务器上。
我能否将它用于自己的商业用途或自行托管?可以,免费使用。但许可证要求署名作者:你必须保留许可证和 NOTICE 文件,并在运行中的应用某处显示署名。
我可以用 AI 助手控制 Doory 吗?可以。它内置了 MCP 服务器(设置 MCPENABLED=true),让 Claude Code 或 Cursor 等客户端能够创建和编辑设计、添加文字和图形、管理评论,并将页面导出为图片,同时使用权限范围受限的令牌进行访问控制。
开始设计前需要注册账号吗?不需要。访客可以直接开始设计,作品会保存在浏览器中;之后注册账号可将这些设计迁移到云端,并解锁分享和品牌套件功能。
支持哪些导出格式?设计可导出为 PNG、JPG、SVG、PDF、MP4、WebM 或 GIF;打印用 PDF 可包含出血线和裁切标记。
内置的元素和素材库有多大?它内置约 27,500 个图标,以及表情符号、插画、贴纸和二维码,还包含 24 段 CC0 许可的音乐循环和 88 个音效。
大小
35.2 MB
星标
2.8K
时长
1个月
提交 · 90 天