hedgedoc_ynh/README.md

# HedgeDoc for YunoHost

[![Integration level](https://dash.yunohost.org/integration/hedgedoc.svg)](https://dash.yunohost.org/appci/app/hedgedoc) ![](https://ci-apps.yunohost.org/ci/badges/hedgedoc.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/hedgedoc.maintain.svg)  
[![Install HedgeDoc with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hedgedoc)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install HedgeDoc quickly and simply on a YunoHost server.  
If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*

## Overview
HedgeDoc ([formerly known as CodiMD](https://hedgedoc.org/history/)) 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.0

## Screenshots

![](https://demo.hedgedoc.org/screenshot.png)

## Demo

* [Official demo](https://demo.hedgedoc.org/)

## Configuration

You can configure HedgeDoc by editing this file `/var/www/hedgedoc/config.json` using the [documentation](https://github.com/hedgedoc/hedgedoc/blob/master/docs/configuration.md)  
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 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/hedgedoc.svg)](https://ci-apps.yunohost.org/ci/apps/hedgedoc/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/hedgedoc.svg)](https://ci-apps-arm.yunohost.org/ci/apps/hedgedoc/)

## 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](https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing).

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
```
-												First commit

											
										
										
											2020-11-19 21:41:03 +01:00
+								# HedgeDoc for YunoHost
 								[![Integration level](https://dash.yunohost.org/integration/hedgedoc.svg)](https://dash.yunohost.org/appci/app/hedgedoc) ![](https://ci-apps.yunohost.org/ci/badges/hedgedoc.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/hedgedoc.maintain.svg)
-												Fix linter warnings

											
										
										
											2020-12-19 11:00:54 +01:00
+								[![Install HedgeDoc with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hedgedoc)
-												First commit

											
										
										
											2020-11-19 21:41:03 +01:00
 								*[Lire ce readme en français.](./README_fr.md)*
 								> *This package allows you to install HedgeDoc quickly and simply on a YunoHost server.
-												Upgrade to version 1.8.0 (#21)

* Upgrade to version 1.8.0
											
										
										
											2021-04-27 06:54:07 +02:00
+								If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
-												First commit

											
										
										
											2020-11-19 21:41:03 +01:00
 								## Overview
-												Patch (#17)

* Cleaning up
											
										
										
											2021-03-12 22:47:43 +01:00
+								HedgeDoc ([formerly known as CodiMD](https://hedgedoc.org/history/)) 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.
-												First commit

											
										
										
											2020-11-19 21:41:03 +01:00
-												Upgrade to version 1.8.0 (#21)

* Upgrade to version 1.8.0
											
										
										
											2021-04-27 06:54:07 +02:00
+								**Shipped version:** 1.8.0
-												First commit

											
										
										
											2020-11-19 21:41:03 +01:00
 								## Screenshots
 								![](https://demo.hedgedoc.org/screenshot.png)
 								## Demo
 								* [Official demo](https://demo.hedgedoc.org/)
 								## Configuration
-												Add restart systemd tuto

											
										
										
											2021-01-02 17:43:30 +01:00
+								You can configure HedgeDoc by editing this file `/var/www/hedgedoc/config.json` using the [documentation](https://github.com/hedgedoc/hedgedoc/blob/master/docs/configuration.md)
-												Update README.md

Add you should reload service for changes in config to be registered.
											
										
										
											2021-01-02 17:34:28 +01:00
+								When you finished editing the configuration, for your changes to take effect, you will have to run: `sudo systemctl restart hedgedoc`.
-												First commit

											
										
										
											2020-11-19 21:41:03 +01:00
 								## Documentation
 								 * Official documentation: https://github.com/hedgedoc/hedgedoc/tree/master/docs
-												Patch (#17)

* Cleaning up
											
										
										
											2021-03-12 22:47:43 +01:00
+								 * YunoHost documentation: https://yunohost.org/en/app_hedgedoc
-												First commit

											
										
										
											2020-11-19 21:41:03 +01:00
 								## YunoHost specific features
 								#### Multi-user support
 								* Is LDAP supported? **Yes**
 								* Can the app be used by multiple users? **Yes**
 								#### Supported architectures
-												fix badges

											
										
										
											2021-04-04 07:09:32 +02:00
+								* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/hedgedoc.svg)](https://ci-apps.yunohost.org/ci/apps/hedgedoc/)
 								* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/hedgedoc.svg)](https://ci-apps-arm.yunohost.org/ci/apps/hedgedoc/)
-												First commit

											
										
										
											2020-11-19 21:41:03 +01:00
-												Add limitations

											
										
										
											2020-12-28 10:46:38 +01:00
+								## Limitations
 								* HedgeDoc needs more than 3 GB of RAM to build.
-												First commit

											
										
										
											2020-11-19 21:41:03 +01:00
+								## Links
 								 * Report a bug: https://github.com/YunoHost-Apps/hedgedoc_ynh/issues
-												small fixes

											
										
										
											2020-11-19 21:56:06 +01:00
+								 * App website: https://hedgedoc.org
-												First commit

											
										
										
											2020-11-19 21:41:03 +01:00
+								 * Upstream app repository: https://github.com/hedgedoc/hedgedoc
 								 * YunoHost website: https://yunohost.org/
 								---
 								## Developer info
 								Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing).
 								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
 								```