1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/hedgedoc_ynh.git synced 2024-09-03 19:25:52 +02:00
hedgedoc_ynh/README.md

64 lines
2.3 KiB
Markdown
Raw Normal View History

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)
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)
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.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
hedgedoc is a real-time collaborative word processing web service. It uses Markdown language.
2020-12-24 16:31:32 +01:00
**Shipped version:** 1.7.0
2020-11-19 21:41:03 +01:00
## 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)
## Documentation
* Official documentation: https://github.com/hedgedoc/hedgedoc/tree/master/docs
* YunoHost documentation: https://yunohost.org/#/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%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/hedgedoc/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/hedgedoc%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/hedgedoc/)
## Links
* Report a bug: https://github.com/YunoHost-Apps/hedgedoc_ynh/issues
2020-11-19 21:56:06 +01:00
* App website: https://hedgedoc.org
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
```