mirror of
https://github.com/YunoHost-Apps/hedgedoc_ynh.git
synced 2024-09-03 19:25:52 +02:00
ad2d45a907
* Small fixes
* 1.7.0 (#4)
* Upgrde to v.1.7.0
* Set requirements to 3.8.1
* Update README.md
* Upgrade to 1.7.1 (#6)
* Add limitations
* Avoid to buid frontend bundle
* Remove PostegrSQL warning
* Update README.md
Add you should reload service for changes in config to be registered.
* Add restart systemd tuto
* Change version
* Finding an available port
* Upgrade to version 1.7.2 (#12)
* Patch (#17)
* Cleaning up
* Update manifest.json
* Cleaning up
* Secure config file
* Remove yarn
* Update change_url
* Update change_url
* Revert "Remove yarn"
This reverts commit a8cabf0c0a.
* Update change_url
* Update systemd.service
* Update systemd.service
* Cleaning up
* Fix
* fix badges
* Upgrade to version 1.8.0 (#21)
* Upgrade to version 1.8.0
* Upgrade to 1.8.0
* Upgrade to 1.8.0
* Upgrade to version 1.8.1
* [autopatch] Update issue and PR templates (#25)
Co-authored-by: Yunohost-Bot <>
* Add templates
* Upgrade to 1.8.2
* Update check_process
* Add templates
* Auto-update README
* Set new requirements (#28)
* Fix
* Simplify config
* Auto-update README
Co-authored-by: Yunohost-Bot <>
* Update manifest.json
* Auto-update README
* 1.9.0 (#31)
* 1.9.0
* Update manifest.json
* Auto-update README
* Systemd hardening (#33)
* Update systemd.service
* Update app.src
* Update manifest.json
* 1.9.1 (#34)
* Upgrade to 1.9.1
* 1.9.2 (#36)
* Remove replace_string
* Fix (#39)
* Update manifest.json
* Auto-update README
* Update config.json.example
* Update config.json.example
* 1.9.3
* Auto-update README
* 1.9.4 (#42)
* 1.9.4
* Auto-update README
Co-authored-by: yunohost-bot <yunohost@yunohost.org>
* Auto-update README
* Update manifest.json
* Update _common.sh
* set relative path for --keep opt
* Update manifest.json
* Auto-update README
* 1.9.5
* Auto-update README
* 1.9.6
* Auto-update README
Co-authored-by: Eauchat <34686393+eauchat@users.noreply.github.com>
Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org>
Co-authored-by: YunoHost Bot <yunohost-bot@users.noreply.github.com>
Co-authored-by: Yunohost-Bot <>
Co-authored-by: yunohost-bot <yunohost@yunohost.org>
Co-authored-by: yalh76 <yalh@yahoo.com>
66 lines
2.6 KiB
Markdown
66 lines
2.6 KiB
Markdown
<!--
|
||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||
It shall NOT be edited by hand.
|
||
-->
|
||
|
||
# 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) is an open-source, web-based, self-hosted, collaborative markdown editor.
|
||
|
||
You can use it to 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.
|
||
|
||
### Features
|
||
|
||
- Real-time collaboration
|
||
- Graphs & diagrams
|
||
- Revisions
|
||
- Presentation mode
|
||
- Easy to use permission system
|
||
- Low system requirements
|
||
|
||
**Shipped version:** 1.9.6~ynh1
|
||
|
||
**Demo:** https://demo.hedgedoc.org/
|
||
|
||
## Screenshots
|
||
|
||
|
||
|
||
## Disclaimers / important information
|
||
|
||
## 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 and resources
|
||
|
||
* Official app website: <https://hedgedoc.org>
|
||
* Official admin documentation: <https://docs.hedgedoc.org/>
|
||
* Upstream app code repository: <https://github.com/hedgedoc/hedgedoc>
|
||
* YunoHost documentation for this app: <https://yunohost.org/app_hedgedoc>
|
||
* Report a bug: <https://github.com/YunoHost-Apps/hedgedoc_ynh/issues>
|
||
|
||
## 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.
|
||
|
||
``` bash
|
||
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
|
||
```
|
||
|
||
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|