Reference

Support and contributing

Burrow is free and made by one person. Here is how to report bugs, contribute, or support it.

On this page

Report a bug

Open an issue on GitHub. It helps to include your Burrow version (it’s in the sidebar), your operating system, and the steps that lead to the problem.

Security issues

Please don’t report security problems as public issues. Use the contact form instead. Report a vulnerability explains what to include.

Contribute

Pull requests are welcome. To get started, build Burrow from source, then use these while you work:

bash

npm run dev          # the app with hot reload
npm run dev:server   # test SSH + SFTP server on 127.0.0.1:2222 (user dev, password dev)
npm test             # unit and integration tests
npm run typecheck

The code is split the usual Electron way:

src/main runs in Node.js and does everything that matters: SSH, SFTP, the vault, storage and sync.
src/renderer is the React UI. It runs sandboxed, has no Node.js access and only talks to the main process through the small API in src/preload.
server/ is the optional sync server.

Support the project

If Burrow saves you some hassle, you can buy me a coffee on Ko-fi.

License

Burrow is released under the MIT license.