mirror of
https://github.com/YunoHost-Apps/hedgedoc_ynh.git
synced 2024-09-03 19:25:52 +02:00
68 lines
2.7 KiB
Markdown
68 lines
2.7 KiB
Markdown
# HedgeDoc for YunoHost
|
||
|
||
[](https://dash.yunohost.org/appci/app/hedgedoc)  
|
||
[](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.2
|
||
|
||
## Screenshots
|
||
|
||
|
||
|
||
## 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 - [](https://ci-apps.yunohost.org/ci/apps/hedgedoc/)
|
||
* ARMv8-A - [](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
|
||
```
|