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

54 lines
2.2 KiB
Markdown
Raw Normal View History

Testing (#29) * Add templates
2021-06-19 16:49:27 +02:00
<!--
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.
-->
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)*
Testing (#29) * Add templates
2021-06-19 16:49:27 +02:00
> *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.*
First commit
2020-11-19 21:41:03 +01:00
## Overview
Testing (#29) * Add templates
2021-06-19 16:49:27 +02:00
Collaborative editor to work on notes written in Markdown
First commit
2020-11-19 21:41:03 +01:00
Testing (#41) * 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 a8cabf0c0addf8f9c4569b27ae04512db5c93df0. * 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 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>
2022-04-11 08:50:49 +02:00
**Shipped version:** 1.9.3~ynh1
First commit
2020-11-19 21:41:03 +01:00
Testing (#29) * Add templates
2021-06-19 16:49:27 +02:00
**Demo:** https://demo.hedgedoc.org/
## Screenshots
First commit
2020-11-19 21:41:03 +01:00
Testing (#29) * Add templates
2021-06-19 16:49:27 +02:00
![](./doc/screenshots/screenshot.png)
First commit
2020-11-19 21:41:03 +01:00
Testing (#29) * Add templates
2021-06-19 16:49:27 +02:00
## Disclaimers / important information
First commit
2020-11-19 21:41:03 +01:00
## Configuration
Testing (#11) 1.7.1 release tarball includes the frontend.
2021-01-03 09:31:15 +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)
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
Testing (#29) * Add templates
2021-06-19 16:49:27 +02:00
## Documentation and resources
First commit
2020-11-19 21:41:03 +01:00
Testing (#29) * Add templates
2021-06-19 16:49:27 +02:00
* 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
First commit
2020-11-19 21:41:03 +01:00
## 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
```
Testing (#29) * Add templates
2021-06-19 16:49:27 +02:00
**More info regarding app packaging:** https://yunohost.org/packaging_apps
Reference in a new issue Copy permalink