hedgedoc_ynh/README.md

HedgeDoc for YunoHost

Lire ce readme en français.

This package allows you to install HedgeDoc quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

HedgeDoc (formerly known as CodiMD) is an open-source collaborative markdown editor. With HedgeDoc you can easily collaborate on notes, graphs and even presentations in real-time. All you need to do is to share your note-link to your co-workers, and they’re ready to go.

Shipped version: 1.8.1

Screenshots

Demo

• Official demo

Configuration

You can configure HedgeDoc by editing this file /var/www/hedgedoc/config.json using the documentation
When you finished editing the configuration, for your changes to take effect, you will have to run: sudo systemctl restart hedgedoc.

Documentation

• Official documentation: https://github.com/hedgedoc/hedgedoc/tree/master/docs
• YunoHost documentation: https://yunohost.org/en/app_hedgedoc

YunoHost specific features

Multi-user support

• Is LDAP supported? Yes
• Can the app be used by multiple users? Yes

Supported architectures

• x86-64 -
• ARMv8-A -

Limitations

• HedgeDoc needs more than 3 GB of RAM to build.

Links

• Report a bug: https://github.com/YunoHost-Apps/hedgedoc_ynh/issues
• App website: https://hedgedoc.org
• Upstream app repository: https://github.com/hedgedoc/hedgedoc
• YunoHost website: https://yunohost.org/

---

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug
or
sudo yunohost app upgrade hedgedoc -u https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug