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

Testing (#29)

Browse source 
* Add templates
This commit is contained in:
Éric Gaspar 2021-06-19 16:49:27 +02:00 committed by GitHub
parent 6df04d56d5
commit eae9570d66
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 69 additions and 110 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
README.md
View file

@ -1,3 +1,8 @@
<!--
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
[![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)
@ -5,56 +10,36 @@
*[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.*
> *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
Collaborative editor to work on notes written in Markdown
**Shipped version:** 1.8.2~ynh2
**Demo:** https://demo.hedgedoc.org/
## Screenshots
![](https://demo.hedgedoc.org/screenshot.png)
![](./doc/screenshots/screenshot.png)
## Demo
* [Official demo](https://demo.hedgedoc.org/)
## 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
## Documentation and resources
* 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/
---
* Official app website: https://hedgedoc.org
* Official user documentation: https://yunohost.org/en/app_hedgedoc
* 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
@ -66,3 +51,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/tes
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

57
README_fr.md
View file

@ -3,58 +3,39 @@
[![Niveau d'intégration](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)
[![Installer HedgeDoc avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hedgedoc)
*[Read this readme in english.](./README.md)*
*[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)*
> *Ce package vous permet d'installer HedgeDoc rapidement et simplement sur un serveur YunoHost.
Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/install) pour apprendre comment l'installer.*
> *Ce package vous permet d'installer HedgeDoc rapidement et simplement sur un serveur YunoHost.
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble
HedgeDoc ([anciennement connu sous le nom de CodiMD](https://hedgedoc.org/history/)) est un éditeur Markdown collaboratif open-source. Avec HedgeDoc, vous pouvez facilement collaborer sur des notes, des graphiques et même des présentations en temps réel. Tout ce que vous avez à faire est de partager votre lien de note avec vos collègues.
**Version incluse :** 1.8.2
Éditeur collaboratif pour travailler sur des notes en Markdown
**Version incluse :** 1.8.2~ynh2
**Démo :** https://demo.hedgedoc.org/
## Captures d'écran
![](https://demo.hedgedoc.org/screenshot.png)
![](./doc/screenshots/screenshot.png)
## Démo
* [Démo officielle](https://demo.hedgedoc.org/)
## Avertissements / informations importantes
## Configuration
Vous pouvez configurer HedgeDoc en modifiant le fichier `/var/www/hedgedoc/config.json` et en vous aidant de la [documentation](https://github.com/hedgedoc/hedgedoc/blob/master/docs/configuration.md)
Lorsque vous avez terminé de modifier la configuration, pour que vos modifications prennent effet, vous devrez exécuter : `sudo systemctl restart hedgedoc`.
## Documentation
## Documentations et ressources
* Documentation officielle : https://github.com/hedgedoc/hedgedoc/tree/master/docs
* Documentation YunoHost : https://yunohost.org/fr/app_hedgedoc
## Caractéristiques spécifiques YunoHost
#### Support multi-utilisateur
* L'authentification LDAP est-elle prise en charge ? **Oui**
* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui**
#### Architectures supportées
* 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 a besoin de plus de 3 Go de RAM pour être installé.
## Liens
* Signaler un bug : https://github.com/YunoHost-Apps/hedgedoc_ynh/issues
* Site de l'application : https://hedgedoc.org
* Dépôt de l'application principale : https://github.com/hedgedoc/hedgedoc
* Site web YunoHost : https://yunohost.org/
---
* Site officiel de l'app : https://hedgedoc.org
* Documentation officielle utilisateur : https://yunohost.org/en/app_hedgedoc
* Documentation officielle de l'admin : https://docs.hedgedoc.org/
* Dépôt de code officiel de l'app : https://github.com/hedgedoc/hedgedoc
* Documentation YunoHost pour cette app : https://yunohost.org/app_hedgedoc
* Signaler un bug : https://github.com/YunoHost-Apps/hedgedoc_ynh/issues
## Informations pour les développeurs
@ -66,3 +47,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/tes
ou
sudo yunohost app upgrade hedgedoc -u https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug
```
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps

8
check_process
View file

@ -1,9 +1,9 @@
;; Test complet
; Manifest
domain="domain.tld" (DOMAIN)
path="/path" (PATH)
admin="john" (USER)
is_public=1 (PUBLIC|public=1|private=0)
domain="domain.tld"
path="/path"
admin="john"
is_public=1
; Checks
pkg_linter=1
setup_sub_dir=1

4
doc/DISCLAIMER.md Normal file
View file

@ -0,0 +1,4 @@
## 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`.

4
doc/DISCLAIMER_fr.md Normal file
View file

@ -0,0 +1,4 @@
## Configuration
Vous pouvez configurer HedgeDoc en modifiant le fichier `/var/www/hedgedoc/config.json` et en vous aidant de la [documentation](https://github.com/hedgedoc/hedgedoc/blob/master/docs/configuration.md)
Lorsque vous avez terminé de modifier la configuration, pour que vos modifications prennent effet, vous devrez exécuter : `sudo systemctl restart hedgedoc`.

BIN
doc/screenshots/screenshot.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 243 KiB

14
manifest.json
View file

@ -6,14 +6,22 @@
"en": "Collaborative editor to work on notes written in Markdown",
"fr": "Éditeur collaboratif pour travailler sur des notes en Markdown"
},
"version": "1.8.2~ynh1",
"url": "https://github.com/hedgedoc/hedgedoc",
"version": "1.8.2~ynh2",
"url": "https://hedgedoc.org",
"upstream": {
"license": "free",
"website": "https://hedgedoc.org",
"demo": "https://demo.hedgedoc.org/",
"admindoc": "https://docs.hedgedoc.org/",
"userdoc": "https://yunohost.org/en/app_hedgedoc",
"code": "https://github.com/hedgedoc/hedgedoc"
},
"license": "AGPL-3.0-only",
"maintainer": {
"name": "eric_G"
},
"requirements": {
"yunohost": ">= 4.1.7"
"yunohost": ">= 4.2.4"
},
"multi_instance": true,
"services": [

13
scripts/change_url
View file

@ -113,18 +113,9 @@ fi
ynh_backup_if_checksum_is_different --file="$final_path/config.json"
domain=$new_domain
path_url=$new_path
path=${new_path:1}
cp ../conf/config.json.example "$final_path/config.json"
ynh_replace_string --match_string="__PORT__" --replace_string="$port" --target_file="$final_path/config.json"
ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain" --target_file="$final_path/config.json"
ynh_replace_string --match_string="__PATH__" --replace_string="${path_url:1}" --target_file="$final_path/config.json"
ynh_replace_string --match_string="__DB_NAME__" --replace_string="$db_name" --target_file="$final_path/config.json"
ynh_replace_string --match_string="__DB_PWD__" --replace_string="$db_pwd" --target_file="$final_path/config.json"
ynh_replace_string --match_string="__APP__" --replace_string="$app" --target_file="$final_path/config.json"
ynh_store_file_checksum --file="$final_path/config.json"
ynh_add_config --template="../conf/config.json.example" --destination="$final_path/config.json"
#=================================================
# GENERIC FINALISATION

2
scripts/install
View file

@ -86,7 +86,6 @@ ynh_system_user_create --username=$app --home_dir=$final_path
ynh_script_progression --message="Creating a PostgreSQL database..." --weight=2
db_name=$(ynh_sanitize_dbid --db_name=$app)
db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd)
ynh_app_setting_set --app=$app --key=db_name --value=$db_name
ynh_psql_test_if_first_run
ynh_psql_setup_db --db_user=$db_name --db_name=$db_name
@ -126,7 +125,6 @@ popd || ynh_die
ynh_script_progression --message="Configuring a systemd service..." --weight=1
ynh_replace_string --match_string="__ENV_PATH__" --replace_string="$PATH" --target_file="../conf/systemd.service"
ynh_replace_string --match_string="__YNH_NPM__" --replace_string="$ynh_npm" --target_file="../conf/systemd.service"
ynh_add_systemd_config

18
scripts/upgrade
View file

@ -82,23 +82,8 @@ if [ "$upgrade_type" == "UPGRADE_APP" ]
then
ynh_script_progression --message="Upgrading source files..." --weight=10
# Create a temporary directory
tmpdir="$(mktemp -d)"
# Backup the config file in the temp dir
cp -a "$final_path/config.json" "$tmpdir/config.json"
# Remove the app directory securely
ynh_secure_remove --file=$final_path
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir=$final_path
#Copy the admin saved settings from tmp directory to final path
cp -a "$tmpdir/config.json" "$final_path/config.json"
# Remove the tmp directory securely
ynh_secure_remove --file="$tmpdir"
ynh_setup_source --dest_dir=$final_path --keep="$final_path/config.json"
fi
#=================================================
@ -143,7 +128,6 @@ fi
ynh_script_progression --message="Configuring a systemd service..." --weight=2
ynh_replace_string --match_string="__ENV_PATH__" --replace_string="$PATH" --target_file="../conf/systemd.service"
ynh_replace_string --match_string="__YNH_NPM__" --replace_string="$ynh_npm" --target_file="../conf/systemd.service"
# Create a dedicated systemd config
ynh_add_systemd_config