2020-11-15 19:23:48 +00:00
2015-05-04 07:53:29 +00:00
2020-07-02 15:22:52 +00:00
# HedgeDoc
[![#HedgeDoc on matrix.org][matrix.org-image]][matrix.org-url]
2017-10-08 11:15:29 +00:00
[![version][github-version-badge]][github-release-page]
2018-04-11 07:38:45 +00:00
[![POEditor][poeditor-image]][poeditor-url]
2019-05-20 01:10:39 +00:00
[![Mastodon][social-mastodon-image]][social-mastodon]
2015-08-15 04:15:42 +00:00
2020-07-02 15:22:52 +00:00
HedgeDoc lets you create real-time collaborative markdown notes. You can test-drive
it by visiting our [HedgeDoc demo server][hedgedoc-demo].
2020-07-29 19:06:49 +00:00
2019-03-31 14:02:05 +00:00
It is inspired by Hackpad, Etherpad and similar collaborative editors. This
project originated with the team at [HackMD ](https://hackmd.io ) and now forked
into its own organisation. [A longer writeup can be read in the history doc ](docs/history.md ).
2015-05-04 07:53:29 +00:00
2020-11-15 19:12:22 +00:00
[][hedgedoc-demo-features]
2015-05-15 04:58:13 +00:00
2019-03-31 14:02:05 +00:00
## Community and Contributions
2017-10-13 07:59:57 +00:00
2019-04-03 21:09:36 +00:00
We welcome contributions! There's a lot to do: If you would like to report bugs,
the [issue tracker][github-issue-tracker] is the right place. If you can help
translating, find us on [POEditor][poeditor-url]. To get started developing,
2019-03-31 14:02:05 +00:00
take a look at the [docs/dev ](docs/dev ) directory. In any case: come talk to us,
we'll be delighted to help you with the first steps.
2016-06-01 16:13:01 +00:00
2019-04-03 21:09:36 +00:00
To stay up to date with our work or get support it's recommended to join our
2020-07-02 15:22:52 +00:00
[Matrix channel][matrix.org-url], stop by our [community forums][hedgedoc-community]
2019-04-03 21:09:36 +00:00
or subscribe to the [release feed][github-release-feed]. We also engage in
2020-07-02 15:22:52 +00:00
regular [community calls][hedgedoc-community-calls] ([RSS](https://community.hedgedoc.org/t/codimd-community-call/19.rss)) which you are very welcome to join.
2018-04-04 23:21:20 +00:00
2019-03-31 14:02:05 +00:00
## Installation / Upgrading
2016-10-04 08:41:26 +00:00
2020-07-02 15:22:52 +00:00
You can run HedgeDoc in a number of ways, and we created setup instructions for
2019-03-31 14:02:05 +00:00
all of these:
2017-10-08 11:37:20 +00:00
2020-07-01 09:52:17 +00:00
- [Docker ](docs/setup/docker.md )
- [Kubernetes ](docs/setup/kubernetes.md )
- [Cloudron ](docs/setup/cloudron.md )
- [LinuxServer.io (multi-arch docker) ](docs/setup/docker-linuxserver.md )
- [Heroku ](docs/setup/heroku.md )
- [Manual setup ](docs/setup/manual-setup.md )
2017-10-08 11:37:20 +00:00
2019-03-31 14:02:05 +00:00
## Configuration
2016-10-04 08:41:26 +00:00
2020-07-02 15:22:52 +00:00
Theres two main ways to [configure ](docs/configuration.md ) your HedgeDoc instance:
2020-06-15 14:47:53 +00:00
config file or environment variables. You can choose what works best for you.
2015-05-15 04:58:13 +00:00
2020-07-02 15:22:52 +00:00
HedgeDoc can integrate with
2016-10-04 08:41:26 +00:00
2020-07-01 09:52:17 +00:00
- facebook, twitter, github, gitlab, mattermost, dropbox, google, ldap, saml and [oauth2 ](docs/guides/auth/oauth.md ) **for login**
- imgur, s3, minio, azure **for image/attachment storage** (files can also be local!)
- dropbox **for export and import**
2018-06-24 11:22:51 +00:00
2019-03-31 14:02:05 +00:00
More info about that can be found in the configuration docs above.
2016-04-20 10:03:55 +00:00
2019-03-31 14:02:05 +00:00
## Browser support
2016-03-15 03:30:43 +00:00
2020-07-02 15:22:52 +00:00
To use HedgeDoc, your browser should match or exceed these versions:
2015-05-08 03:52:30 +00:00
2020-06-26 07:41:34 +00:00
-  Chrome >= 47,  Chrome for Android >= 47
-  Safari >= 9,  iOS Safari >= 8.4
-  Firefox >= 44
-  IE >= 9,  Edge >= 12
-  Opera >= 34,  Opera Mini not supported
-  Android Browser >= 4.4
2017-10-08 11:37:20 +00:00
2020-09-01 13:08:51 +00:00
## Backup/restore your instance
2020-07-02 15:22:52 +00:00
To backup HedgeDoc, you should:
2020-09-01 13:08:51 +00:00
- backup your database
- backup your custom config file if you have one
2020-07-02 15:22:52 +00:00
- backup the upload folder (see the [uploadsPath ](./docs/configuration.md#hedgedoc-paths-stuff ) config directive)
2020-09-01 13:08:51 +00:00
2020-07-02 15:22:52 +00:00
Restoring an existing instance of HedgeDoc is then just a matter of restoring these elements.
2020-09-01 13:08:51 +00:00
2019-04-03 21:09:36 +00:00
## Related Tools
2020-07-02 15:22:52 +00:00
Our community has created related tools, we'd like to highlight [hedgedoc-cli ](https://github.com/hedgedoc/cli )
which lets you use HedgeDoc from the comfort of your command line.
2019-04-03 21:09:36 +00:00
2020-07-01 09:52:17 +00:00
## License
2017-10-08 11:37:20 +00:00
2019-03-31 14:02:05 +00:00
Licensed under AGPLv3. For our list of contributors, see [AUTHORS ](AUTHORS ).
2017-03-14 15:30:35 +00:00
2020-07-02 15:22:52 +00:00
The license does not include the HedgeDoc logo, whose terms of usage can be found in the [github repository ](https://github.com/hedgedoc/hedgedoc-logo ).
2020-09-08 08:06:30 +00:00
[matrix.org-image]: https://img.shields.io/matrix/hedgedoc:matrix.org?logo=matrix& server_fqdn=matrix.org
2020-09-28 11:05:22 +00:00
[matrix.org-url]: https://matrix.to/#/#hedgedoc:matrix.org
2020-07-02 15:22:52 +00:00
[github-version-badge]: https://img.shields.io/github/release/hedgedoc/hedgedoc.svg
[github-release-page]: https://github.com/hedgedoc/hedgedoc/releases
[github-release-feed]: https://github.com/hedgedoc/hedgedoc/releases.atom
[github-issue-tracker]: https://github.com/hedgedoc/hedgedoc/issues/
2018-04-16 19:08:24 +00:00
[poeditor-image]: https://img.shields.io/badge/POEditor-translate-blue.svg
2018-04-11 07:38:45 +00:00
[poeditor-url]: https://poeditor.com/join/project/1OpGjF2Jir
2020-07-02 15:22:52 +00:00
[hedgedoc-demo]: https://demo.hedgedoc.org
[hedgedoc-demo-features]: https://demo.hedgedoc.org/features
[hedgedoc-community]: https://community.hedgedoc.org
[hedgedoc-community-calls]: https://community.hedgedoc.org/t/codimd-community-call/19
[social-mastodon]: https://social.hedgedoc.org/mastodon
2019-08-03 15:50:04 +00:00
[social-mastodon-image]: https://img.shields.io/mastodon/follow/18547?domain=https%3A%2F%2Fsocial.snopyta.org& style=social
