HedgeDoc - Ideas grow better together
Find a file
David Mehren c9388add9d
Add FAQ entry about iframing HedgeDoc
Signed-off-by: David Mehren <git@herrmehren.de>
2021-08-14 23:48:17 +02:00
.github CI: Use short Node versions 2021-08-14 16:54:26 +02:00
bin Merge pull request #1246 from hedgedoc/fix/heroku_pg_ssl 2021-05-09 14:59:29 +02:00
docs Add FAQ entry about iframing HedgeDoc 2021-08-14 23:48:17 +02:00
lib Merge pull request #1533 from hedgedoc/feature/database-env 2021-08-14 23:41:58 +02:00
locales Extract list of supported languages in separate file 2021-04-26 21:45:31 +02:00
public Add changelog entry for DB auto-reconnect 2021-08-14 22:23:26 +02:00
test Disable GA and Disqus in default CSP 2021-06-07 22:57:12 +02:00
.babelrc Use esbuild to minify frontend JS 2021-05-06 21:13:56 +02:00
.editorconfig Replace CodiMD with HedgeDoc 2020-11-14 21:18:36 +01:00
.eslintignore switching to eslint for code checking 2018-11-14 23:15:36 +01:00
.eslintrc.js Add no-console as a warning 2019-05-12 20:15:46 +02:00
.gitignore added documentation about how the write, build and deploy this 2021-01-04 14:26:39 +01:00
.mailmap Update .mailmap and AUTHORS 2020-11-27 22:23:08 +01:00
.remarkrc fix: override markdown linting preset 2020-07-10 18:57:31 +02:00
app.js Merge pull request #1537 from hedgedoc/maint/remove_ws 2021-08-14 23:24:46 +02:00
app.json Remove pdf export code 2020-11-26 21:09:23 +01:00
AUTHORS Update .mailmap and AUTHORS 2020-11-27 22:23:08 +01:00
CHANGELOG.md Replace CodiMD with HedgeDoc 2020-11-14 21:18:36 +01:00
CODE-OF-CONDUCT.md style: linting markdown files 2020-07-10 18:57:59 +02:00
config.json.example Update example config 2021-05-06 22:24:02 +02:00
CONTRIBUTING.md Fix link to DCO in contributing docs 2021-01-22 18:10:47 +01:00
LICENSE Replace slogan 2020-11-14 22:23:18 +01:00
package.json Merge pull request #1537 from hedgedoc/maint/remove_ws 2021-08-14 23:24:46 +02:00
README.md Fix logo link in README.md 2021-04-25 22:49:24 +02:00
renovate.json Change label used by renovate to "type: maintenance" 2020-11-30 18:24:43 +01:00
SECURITY.md Replace references to Matrix room with chat.hedgedoc.org 2020-11-27 19:53:26 +01:00
webpack.common.js Lazy-load highlight.js 2021-06-11 09:29:27 +02:00
webpack.dev.js Don't use eval-based source maps 2021-06-07 23:04:45 +02:00
webpack.htmlexport.js Fix urlPath support, let CodiMD be served from a subpath correctly 2019-12-20 12:03:16 +01:00
webpack.prod.js Exclude mathjax a11y files from ESBuild 2021-08-14 16:18:23 +02:00
yarn.lock Merge pull request #1537 from hedgedoc/maint/remove_ws 2021-08-14 23:24:46 +02:00

HedgeDoc Logo

HedgeDoc

#HedgeDoc on matrix.org version POEditor Mastodon

HedgeDoc lets you create real-time collaborative markdown notes. You can test-drive it by visiting our HedgeDoc demo server.

It is inspired by Hackpad, Etherpad and similar collaborative editors. This project originated with the team at HackMD and now forked into its own organisation. A longer writeup can be read in the history.

HedgeDoc 1.7.0 with its feature demonstration page open

Community and Contributions

We welcome contributions! There's a lot to do: If you would like to report bugs, the issue tracker is the right place. If you can help translating, find us on POEditor. To get started developing, take a look at the developer documentation. In any case: come talk to us, we'll be delighted to help you with the first steps.

To stay up to date with our work or get support it's recommended to join our Matrix channel, stop by our community forums or subscribe to the release feed. We also engage in regular community calls (RSS) which you are very welcome to join.

Installation / Upgrading

You can run HedgeDoc in a number of ways, and we created setup instructions for all of these:

Configuration

Theres two main ways to configure your HedgeDoc instance: config file or environment variables. You can choose what works best for you.

HedgeDoc can integrate with

  • facebook, twitter, github, gitlab, mattermost, dropbox, google, ldap, saml and oauth2 for login
  • imgur, s3, minio, azure for image/attachment storage (files can also be local!)
  • dropbox for export and import

More info about that can be found in the configuration docs above.

Browser support

To use HedgeDoc, your browser should match or exceed these versions:

  • Chrome Chrome >= 47, Chrome Chrome for Android >= 47
  • Safari Safari >= 9, iOS Safarai iOS Safari >= 8.4
  • Firefox Firefox >= 44
  • Edge Edge >= 12
  • Opera Opera >= 34, Opera Mini Opera Mini not supported
  • Android Browser Android Browser >= 4.4

Backup/restore your instance

To backup HedgeDoc, you should:

  • backup your database
  • backup your custom config file if you have one
  • backup the upload folder (see the uploadsPath config directive)

Restoring an existing instance of HedgeDoc is then just a matter of restoring these elements.

Our community has created related tools, we'd like to highlight hedgedoc-cli which lets you use HedgeDoc from the comfort of your command line.

License

Licensed under AGPLv3. For our list of contributors, see AUTHORS.

The license does not include the HedgeDoc logo, whose terms of usage can be found in the github repository.