drawio-desktop README

The project's README from github.com/jgraph/drawio-desktop. As one markdown file: README.md.

About

drawio-desktop is a diagramming desktop app based on Electron that wraps the core draw.io editor.

Download built binaries from the releases section.

Can I use this app for free? Yes, under the apache 2.0 license. If you don't change the code and accept it is provided "as-is", you can use it for any purpose.

Windows installation

Three flavours of Windows download are published on the releases page:

The Microsoft Store (APPX) build is also installable per-user without admin rights via the Store.

Windows on Arm

draw.io Desktop is built natively for Windows on Arm (ARM64) and is supported on Windows 11 ARM64 devices. Two native ARM64 downloads are published with every release:

The MSI and Microsoft Store builds are x64 only and run under emulation on ARM64 devices. ARM64 builds up to and including 31.4.4 were shipped with auto-update disabled; install a newer release manually once, after which the ARM64 build updates itself like x64.

Linux installation

If you manage AppImages with AppImageLauncher, you need a 3.0 release of it (currently labelled beta). Since 31.4.2 the AppImage uses the static AppImage runtime so that it no longer depends on the end-of-life libfuse2, and AppImageLauncher 2.2.0, the last stable release, cannot load a static runtime. The app then fails to start with:

fuse: memory allocation failed
squashfuse 0.5.2 (c) 2012 Dave Vasilevsky
...
Can't open squashfs image: Bad address

Install a current AppImageLauncher from its releases page, which provides .deb packages, or uninstall AppImageLauncher altogether. It is not needed to run the AppImage. See #2538 for the detail.

Security

draw.io Desktop is designed to be completely isolated from the Internet, apart from the update process. This checks github.com at startup for a newer version and downloads it from an AWS S3 bucket owned by Github. To disable the update check entirely (e.g. for centrally-managed installs), set the DRAWIO_DISABLE_UPDATE=true environment variable or pass --disable-update on launch. All JavaScript files are self-contained, the Content Security Policy forbids running remotely loaded JavaScript.

No diagram data is ever sent externally, nor do we send any analytics about app usage externally. The Content Security Policy on the web part of the interface forbids remotely-loaded JavaScript and restricts the application's own network connections to itself, so the app cannot transmit your diagrams or otherwise phone home. Note that a diagram can reference external media - for example an image, background or font loaded from a URL embedded in the diagram - and these are fetched when the diagram is opened so that it renders correctly. Opening a diagram from an untrusted source may therefore trigger a request to the referenced URL, which can reveal metadata such as your IP address to that server; no diagram content is transmitted.

Security and isolating the app are the primarily objectives of draw.io desktop. If you ask for anything that involves external connections enabled in the app by default, the answer will be no.

Support

Support is provided on a reasonable business constraints basis, but without anything contractually binding. All support is provided via this repo. There is no private ticketing support for non-paying users.

Purchasing draw.io for Confluence or Jira does not entitle you to commercial support for draw.io desktop.

Developing

draw.io is a git submodule of drawio-desktop. To get both you need to clone recursively:

git clone --recursive https://github.com/jgraph/drawio-desktop.git

To run this:

  1. npm install (in the root directory of this repo)
  2. [internal use only] export DRAWIO_ENV=dev if you want to develop/debug in dev mode.
  3. npm start in the root directory of this repo runs the app. For debugging, use npm start --enable-logging.

Note: If a symlink is used to refer to drawio repo (instead of the submodule), then symlink the node_modules directory inside drawio/src/main/webapp also.

To fork the project, make your own changes and build an (unsigned) app for personal use, see doc/BUILDING_FOR_PERSONAL_USE.md.

To release:

  1. Update the draw.io sub-module and push the change. Add version tag before pushing to origin.
  2. Wait for the builds to complete (https://travis-ci.org/jgraph/drawio-desktop and https://ci.appveyor.com/project/davidjgraph/drawio-desktop)
  3. Go to https://github.com/jgraph/drawio-desktop/releases, edit the preview release.
  4. Download the windows exe and windows portable, sign them using signtool sign /a /tr http://rfc3161timestamp.globalsign.com/advanced /td SHA256 c:/path/to/your/file.exe
  5. Re-upload signed file as draw.io-windows-installer-x.y.z.exe and draw.io-windows-no-installer-x.y.z.exe
  6. Add release notes
  7. Publish release

Local Storage and Session Storage is stored in the AppData folder:

Not open-contribution

draw.io is closed to contributions (unless a maintainer permits it, which is extremely rare).

The level of complexity of this project means that even simple changes can break a lot of other moving parts. The amount of testing required is far more than it first seems. If we were to receive a PR, we'd have to basically throw it away and write it how we want it to be implemented.

We are grateful for community involvement, bug reports, & feature requests. We do not wish to come off as anything but welcoming, however, we've made the decision to keep this project closed to contributions for the long term viability of the project.

drawio-desktop (jgraph/drawio-desktop)

Searching Database…

Что это такое?drawio-desktop — официальная версия draw.io на базе Electron, настольное приложение для создания диаграмм. Оно оборачивает основной редактор draw.io и позволяет рисовать блок-схемы и другие диаграммы без браузера.
Нужно ли что-то кроме установщика, чтобы просто запустить приложение?Нет, выпущенные сборки работают автономно. Чтобы собрать приложение самостоятельно, нужны Node.js и рекурсивное клонирование репозитория: вместе с ним подтягивается редактор draw.io как подмодуль git. После этого выполните npm install и npm start.
Есть ли подводные камни при установке, о которых стоит знать?Сборки для Windows ARM64 до версии 31.4.4 поставлялись с отключённым автообновлением, поэтому сначала придётся вручную установить один из более новых релизов, и только после этого обновления снова заработают. А в Linux более старый AppImageLauncher (2.2.0) не может запустить статический рантайм AppImage, который используется с версии 31.4.2, и приложение не запустится.
На каких операционных системах это работает?Официально поддерживаются Windows (x64 и нативная ARM64), macOS и Linux (в виде AppImage). Для всех них есть официальные загрузки.
Отправляет ли приложение мои диаграммы куда-нибудь?Нет. Приложение изолировано от интернета, за исключением проверки обновлений при запуске, и никогда не передаёт содержимое диаграмм или данные об использовании во внешние сервисы.
Какая лицензия и сколько это стоит?В README сказано, что приложение можно использовать бесплатно в любых целях по лицензии Apache 2.0, если вы не изменяете код и принимаете его «как есть». В метаданных репозитория на GitHub лицензия указана как GPL-3.0.
Зачем использовать настольное приложение, а не draw.io в браузере?Настольная сборка изолирована от сети, за исключением проверки обновлений, поэтому ваши диаграммы и данные об использовании никуда не отправляются. В отличие от размещённого веб-приложения, так происходит всегда.
Что будет, если диаграмма ссылается на внешнее изображение или шрифт?При открытии диаграммы приложение запросит этот адрес, чтобы корректно её отобразить. Сервер при этом может узнать метаданные, например ваш IP-адрес, хотя само содержимое диаграммы никуда не передаётся.
Можно ли отключить автоматическую проверку обновлений?Да, задайте переменную окружения DRAWIODISABLEUPDATE=true или запустите приложение с параметром --disable-update. Это полезно для установок, которыми управляют централизованно.
What are similar projects?easyread, Zettlr, krita, get-it, Mailspring, forel, QymCAD, edex-ui
Creator
jgraph
Size
3.4 MB
Stars
63.5K
Age
9y
Commits · 90 Days