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 (#75)

Browse source 
* 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

* Add more security as default (#47)

* Add more security as default

* Auto-update README

* Update config.json.example

* Update change_url

Co-authored-by: yunohost-bot <yunohost@yunohost.org>

* Update manifest.json

* Auto-update README

* Update install

* Fix

* Add allow free url to config panel

* Add FreeURL authentication

* Update config.json.example

* Fix

* remove yarn cache

* Auto-update README

* 1.9.7

* Auto-update README

* Update change_url

* Update systemd.service

* Update systemd.service

* Update install

* FIx

* Update manifest.json

* Auto-update README

* Update manifest.json

* Version 2 (#58)

* v2

* fix

* Auto-update README

* Update manifest.toml

* fix

* Update install

* Update upgrade

* Update change_url

* Update install

* fix

* Auto-update README

* Fix

* Auto-update README

* Fix

* fix

* Update manifest.toml

* fix

* fix

* Auto-update README

* Update tests.toml

---------

Co-authored-by: yunohost-bot <yunohost@yunohost.org>

* cleaning

* 1.9.8

* Auto-update README

* Update config_panel.toml

* Build (#63)

* Update install

* cleaning

* Update manifest.toml

* Update manifest.toml

* Auto-update README

* cleaning

* Update manifest.toml

* Update manifest.toml

* Auto-update README

* Update manifest.toml

* Create DESCRIPTION_fr.md

* Auto-update README

* Update DESCRIPTION.md

* Auto-update README

* fix config_panel (#68)

* Upgrade to v1.9.9

* Auto-update README

* Update manifest.toml

* Auto-update README

* Update manifest.toml

* fix config_panel

---------

Co-authored-by: yunohost-bot <yunohost@yunohost.org>
Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>

* Auto-update README

* Auto-update README

* Cleanup yarn cache properly. (#70)

* Update manifest.toml

* Auto-update README

* Auto-update README

* fix

* Update manifest.toml

* remove maintenance

* Auto-update READMEs

* cleaning

* Update _common.sh

* Update manifest.toml

* Auto-update READMEs

---------

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>
Co-authored-by: lapineige <lapineige@users.noreply.github.com>
Co-authored-by: orhtej2 <2871798+orhtej2@users.noreply.github.com>
This commit is contained in:
eric_G 2024-05-28 15:22:44 +02:00 committed by GitHub
parent 1aa1e0327e
commit cb859f05be
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
12 changed files with 216 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
ALL_README.md
View file

@ -1,6 +1,8 @@
# All available README files by language
- [Read the README in English](README.md)
- [Lea el README en español](README_es.md)
- [Irakurri README euskaraz](README_eu.md)
- [Lire le README en français](README_fr.md)
- [Le o README en galego](README_gl.md)
- [Leggi il “README” in italiano](README_it.md)
- [阅读中文（简体）的 README](README_zh_Hans.md)

4
README.md
View file

@ -9,7 +9,7 @@ It shall NOT be edited by hand.
[![Install HedgeDoc with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hedgedoc)
*[Read this README is other languages.](./ALL_README.md)*
*[Read this README in other languages.](./ALL_README.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.*
@ -29,7 +29,7 @@ You can use it to easily collaborate on notes, graphs and even presentations in
- Low system requirements
**Shipped version:** 1.9.9~ynh2
**Shipped version:** 1.9.9~ynh3
**Demo:** <https://demo.hedgedoc.org/>

60
README_es.md Normal file
View file

@ -0,0 +1,60 @@
<!--
Este archivo README esta generado automaticamente<https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
No se debe editar a mano.
-->
# HedgeDoc para Yunohost
[![Nivel de integración](https://dash.yunohost.org/integration/hedgedoc.svg)](https://dash.yunohost.org/appci/app/hedgedoc) ![Estado funcional](https://ci-apps.yunohost.org/ci/badges/hedgedoc.status.svg) ![Estado En Mantención](https://ci-apps.yunohost.org/ci/badges/hedgedoc.maintain.svg)
[![Instalar HedgeDoc con Yunhost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hedgedoc)
*[Leer este README en otros idiomas.](./ALL_README.md)*
> *Este paquete le permite instalarHedgeDoc rapidamente y simplement en un servidor YunoHost.*
> *Si no tiene YunoHost, visita [the guide](https://yunohost.org/install) para aprender como instalarla.*
## Descripción general
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
**Versión actual:** 1.9.9~ynh3
**Demo:** <https://demo.hedgedoc.org/>
## Capturas
![Captura de HedgeDoc](./doc/screenshots/screenshot.png)
## Documentaciones y recursos
- Sitio web oficial: <https://hedgedoc.org>
- Documentación administrador oficial: <https://docs.hedgedoc.org/>
- Repositorio del código fuente oficial de la aplicación : <https://github.com/hedgedoc/hedgedoc>
- Catálogo YunoHost: <https://apps.yunohost.org/app/hedgedoc>
- Reportar un error: <https://github.com/YunoHost-Apps/hedgedoc_ynh/issues>
## Información para desarrolladores
Por favor enviar sus correcciones a la [`branch testing`](https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing
Para probar la rama `testing`, sigue asÍ:
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug
o
sudo yunohost app upgrade hedgedoc -u https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug
```
**Mas informaciones sobre el empaquetado de aplicaciones:** <https://yunohost.org/packaging_apps>

60
README_eu.md Normal file
View file

@ -0,0 +1,60 @@
<!--
Ohart ongi: README hau automatikoki sortu da <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>ri esker
EZ editatu eskuz.
-->
# HedgeDoc YunoHost-erako
[![Integrazio maila](https://dash.yunohost.org/integration/hedgedoc.svg)](https://dash.yunohost.org/appci/app/hedgedoc) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/hedgedoc.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/hedgedoc.maintain.svg)
[![Instalatu HedgeDoc YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hedgedoc)
*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)*
> *Pakete honek HedgeDoc YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.*
> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.*
## Aurreikuspena
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
**Paketatutako bertsioa:** 1.9.9~ynh3
**Demoa:** <https://demo.hedgedoc.org/>
## Pantaila-argazkiak
![HedgeDoc(r)en pantaila-argazkia](./doc/screenshots/screenshot.png)
## Dokumentazioa eta baliabideak
- Aplikazioaren webgune ofiziala: <https://hedgedoc.org>
- Administratzaileen dokumentazio ofiziala: <https://docs.hedgedoc.org/>
- Jatorrizko aplikazioaren kode-gordailua: <https://github.com/hedgedoc/hedgedoc>
- YunoHost Denda: <https://apps.yunohost.org/app/hedgedoc>
- Eman errore baten berri: <https://github.com/YunoHost-Apps/hedgedoc_ynh/issues>
## Garatzaileentzako informazioa
Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing).
`testing` abarra probatzeko, ondorengoa egin:
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug
edo
sudo yunohost app upgrade hedgedoc -u https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug
```
**Informazio gehiago aplikazioaren paketatzeari buruz:** <https://yunohost.org/packaging_apps>

2
README_fr.md
View file

@ -29,7 +29,7 @@ Vous pouvez l'utiliser pour collaborer facilement sur des notes, des graphiques
- Faible configuration système requise
**Version incluse :** 1.9.9~ynh2
**Version incluse :** 1.9.9~ynh3
**Démo :** <https://demo.hedgedoc.org/>

2
README_gl.md
View file

@ -29,7 +29,7 @@ You can use it to easily collaborate on notes, graphs and even presentations in
- Low system requirements
**Versión proporcionada:** 1.9.9~ynh2
**Versión proporcionada:** 1.9.9~ynh3
**Demo:** <https://demo.hedgedoc.org/>

60
README_zh_Hans.md Normal file
View file

@ -0,0 +1,60 @@
<!--
注意：此 README 由 <https://github.com/YunoHost/apps/tree/master/tools/readme_generator> 自动生成
请勿手动编辑。
-->
# YunoHost 上的 HedgeDoc
[![集成程度](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)
[![使用 YunoHost 安装 HedgeDoc](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hedgedoc)
*[阅读此 README 的其它语言版本。](./ALL_README.md)*
> *通过此软件包，您可以在 YunoHost 服务器上快速、简单地安装 HedgeDoc。*
> *如果您还没有 YunoHost，请参阅[指南](https://yunohost.org/install)了解如何安装它。*
## 概况
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
**分发版本：** 1.9.9~ynh3
**演示：** <https://demo.hedgedoc.org/>
## 截图
![HedgeDoc 的截图](./doc/screenshots/screenshot.png)
## 文档与资源
- 官方应用网站： <https://hedgedoc.org>
- 官方管理文档： <https://docs.hedgedoc.org/>
- 上游应用代码库： <https://github.com/hedgedoc/hedgedoc>
- YunoHost 商店： <https://apps.yunohost.org/app/hedgedoc>
- 报告 bug： <https://github.com/YunoHost-Apps/hedgedoc_ynh/issues>
## 开发者信息
请向 [`testing` 分支](https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing) 发送拉取请求。
如要尝试 `testing` 分支，请这样操作：
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug
或
sudo yunohost app upgrade hedgedoc -u https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug
```
**有关应用打包的更多信息：** <https://yunohost.org/packaging_apps>

7
manifest.toml
View file

@ -5,9 +5,9 @@ name = "HedgeDoc"
description.en = "Collaborative editor to work on notes written in Markdown"
description.fr = "Éditeur collaboratif pour travailler sur des notes en Markdown"
version = "1.9.9~ynh2"
version = "1.9.9~ynh3"
maintainers = ["eric_G"]
maintainers = []
[upstream]
license = "AGPL-3.0-only"
@ -20,8 +20,11 @@ code = "https://github.com/hedgedoc/hedgedoc"
yunohost = ">= 11.2"
architectures = "all"
multi_instance = true
ldap = true
sso = true
disk = "50M"
ram.build = "900M"
ram.runtime = "50M"

2
scripts/_common.sh
View file

@ -4,7 +4,7 @@
# COMMON VARIABLES
#=================================================
nodejs_version=18
nodejs_version=20
#=================================================
# PERSONAL HELPERS

8
scripts/backup
View file

@ -21,17 +21,11 @@ ynh_print_info --message="Declaring files to be backed up..."
ynh_backup --src_path="$install_dir"
#=================================================
# BACKUP THE NGINX CONFIGURATION
# SYSTEM CONFIGURATION
#=================================================
ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
#=================================================
# SPECIFIC BACKUP
#=================================================
# BACKUP SYSTEMD
#=================================================
ynh_backup --src_path="/etc/systemd/system/$app.service"
#=================================================

4
scripts/install
View file

@ -64,7 +64,7 @@ yunohost service add $app --description="Collaborative Markdown editor" --log="/
#==============================================
# INSTALL HEDGEDOC
#==============================================
ynh_script_progression --message="Building HedgeDoc... (this will take some time and resources!)" --weight=10
ynh_script_progression --message="Building $app... (this will take some time and resources!)" --weight=10
pushd "$install_dir"
ynh_use_nodejs
@ -78,7 +78,7 @@ popd
ynh_script_progression --message="Modifying a config file..." --weight=1
url_path=${path#/}
ynh_add_config --template="../conf/config.json.example" --destination="$install_dir/config.json"
ynh_add_config --template="config.json.example" --destination="$install_dir/config.json"
chmod 600 "$install_dir/config.json"
chown $app:$app "$install_dir/config.json"

43
scripts/upgrade
View file

@ -9,12 +9,6 @@
source _common.sh
source /usr/share/yunohost/helpers
#=================================================
# CHECK VERSION
#=================================================
upgrade_type=$(ynh_check_app_version_changed)
#=================================================
# ENSURE DOWNWARD COMPATIBILITY
#=================================================
@ -57,14 +51,10 @@ ynh_systemd_action --service_name=$app --action=stop --log_path=systemd
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
ynh_script_progression --message="Upgrading source files..." --weight=10
if [ "$upgrade_type" == "UPGRADE_APP" ]
then
ynh_script_progression --message="Upgrading source files..." --weight=10
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir=$install_dir --keep="config.json"
fi
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir=$install_dir --keep="config.json"
chmod -R o-rwx "$install_dir"
chown -R $app:www-data "$install_dir"
@ -85,18 +75,25 @@ yunohost service add $app --description="Collaborative Markdown editor" --log="/
#==============================================
# INSTALL HEDGEDOC
#==============================================
ynh_script_progression --message="Building $app... (this will take some time and resources!)" --weight=10
if [ "$upgrade_type" == "UPGRADE_APP" ]
then
ynh_script_progression --message="Building $app... (this will take some time and resources!)" --weight=10
pushd "$install_dir"
ynh_secure_remove /usr/local/share/.cache/yarn
ynh_use_nodejs
ynh_exec_warn_less sudo -u $app env $ynh_node_load_PATH yarn workspaces focus --production
ynh_exec_warn_less sudo -u $app env $ynh_node_load_PATH yarn cache clean
popd
pushd "$install_dir"
ynh_secure_remove /usr/local/share/.cache/yarn
ynh_use_nodejs
ynh_exec_warn_less sudo -u $app env $ynh_node_load_PATH yarn workspaces focus --production
ynh_exec_warn_less sudo -u $app env $ynh_node_load_PATH yarn cache clean
popd
fi
#=================================================
# MODIFY A CONFIG FILE
#=================================================
ynh_script_progression --message="Modifying a config file..." --weight=1
url_path=${path#/}
ynh_add_config --template="config.json.example" --destination="$install_dir/config.json"
chmod 600 "$install_dir/config.json"
chown $app:$app "$install_dir/config.json"
#=================================================
# START SYSTEMD SERVICE