yunohost-apps/codimd_ynh

CodiMD package for YunoHost

CodiMD for YunoHost

Lire ce readme en français.

This package allows you to install CodiMD quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

CodiMD is the free software version of HackMD, developed and opened source by the HackMD team with reduced features (without book mode), you can use CodiMD for your community and own all your data. (See the origin of the name CodiMD.)

CodiMD is perfect for open communities, while HackMD emphasizes on permission and access controls for commercial use cases.

Shipped version: 2.5.3~ynh1

Screenshots

Documentation and resources

• Official app website: https://hackmd.io/
• Official user documentation: https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-documentation#User-Guides
• Official admin documentation: https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-documentation#Administration-Guides
• Upstream app code repository: https://github.com/hackmdio/codimd
• YunoHost Store: https://apps.yunohost.org/app/codimd
• Report a bug: https://github.com/YunoHost-Apps/codimd_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/codimd_ynh/tree/testing --debug
or
sudo yunohost app upgrade codimd -u https://github.com/YunoHost-Apps/codimd_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps

codimd_ynh's Issues

Upgrade to 1.6

CodiMD version 1.6 is out https://github.com/codimd/server/releases/tag/1.6.0

PR welcome :)

Consider adding the app to the community list

Hello !

This is a friendly automatic notice from the Yunohost Apps team : our tool noticed that your app is pretty interesting but is not listed in the community list !

Please consider making a pull request to add it, such that people can easily learn about its existence from this page. If you declare your app as working, you might also benefit from automatic tests on the app C.I..

It is relevant to add your app to the list even if it's not working or unmaintained since it might still help people who might want to continue packaging the app. Just be sure to correctly flag it as notworking/unmaintained.

Checkout the README to learn how to add your app to the list (should take only a few minutes).

Datalove <3,

The YunoHost team.

Non-root domain installation

Users should be able to install this app in a sub-folder, not only on the root of their (sub)domain.
Does CodiMD and its nginx config allows that ? 🤔

Can't install on raspberry pi

Not my issue, I'm referencing it here: https://forum.yunohost.org/t/codimd-cant-install-on-raspberry/13358

Change the tooBusyLag value by default

Describe the bug
The default tooBusyLag value is a bit low (70ms). On my server (old computer), I get the * I'm busy right now, try again later* message very often, which is a bit annoying.

Even if that value can be tweaked, what to do you think increasing it by default? (I don't know, to 10000 if that's not too high)

Versions

• Hardware: Old laptop or computer

Implement backup and restore

Now that the app can be installed, we should implement backup and restore scripts.

On upgrade: Unhandled rejection SequelizeConnectionError: password authentication failed for user "codimd"

Versions

• Hardware: Dedicated
• YunoHost version: 4.0.2
• I have access to my server: Through SSH
• Are you in a special context or did you perform some particular tweaking on your YunoHost instance ?: yes
• If yes, please explain: Installed testing first with yunohost install app
• Using, or trying to install package version/branch: testing
• If upgrading, current package version: 1.6.0~ynh2

To Reproduce
Steps to reproduce the behavior.

• If you performed a command from the CLI, the command itself is enough. For example:

  sudo yunohost app upgrade codimd -u https://github.com/YunoHost-Apps/codimd_ynh.git

Expected behavior
App upgraded and working

Logs

Warning: Jun 21 11:11:40 npm[29455]:     at connection.connect.err (/var/www/codimd/node_modules/sequelize/lib/dialects/postgres/connection-manager.js:182:24)
Warning: Jun 21 11:11:40 npm[29455]:     at Connection.connectingErrorHandler (/var/www/codimd/node_modules/pg/lib/client.js:194:14)
Warning: Jun 21 11:11:40 npm[29455]:     at Connection.emit (events.js:198:13)
Warning: Jun 21 11:11:40 npm[29455]:     at Socket.<anonymous> (/var/www/codimd/node_modules/pg/lib/connection.js:134:12)
Warning: Jun 21 11:11:40 npm[29455]:     at Socket.emit (events.js:198:13)
Warning: Jun 21 11:11:40 npm[29455]:     at addChunk (_stream_readable.js:288:12)
Warning: Jun 21 11:11:40 npm[29455]:     at readableAddChunk (_stream_readable.js:269:11)
Warning: Jun 21 11:11:40 npm[29455]:     at Socket.Readable.push (_stream_readable.js:224:10)
Warning: Jun 21 11:11:40 npm[29455]:     at TCP.onStreamRead [as onread] (internal/stream_base_commons.js:94:17)

update is failing (file or dir not found)

running yunohost tools upgrade apps fails:
https://paste.yunohost.org/raw/ilesanobaj

seems it can't find the npm files.

2021-07-15 19:54:41,256: DEBUG - npm WARN tar ENOENT: no such file or directory, open '/var/www/codimd/node_modules/.staging/rxjs-1b0c9ab8/operator/zipAll.d.ts'
2021-07-15 19:54:41,256: DEBUG - npm WARN tar ENOENT: no such file or directory, open '/var/www/codimd/node_modules/.staging/rxjs-1b0c9ab8/operators/zipAll.d.ts'
2021-07-15 19:54:41,256: DEBUG - npm WARN tar ENOENT: no such file or directory, lstat '/var/www/codimd/node_modules/.staging/rxjs-1b0c9ab8/src/add'
2021-07-15 19:54:41,256: DEBUG - npm WARN tar ENOENT: no such file or directory, lstat '/var/www/codimd/node_modules/.staging/rxjs-1b0c9ab8/src/internal'
2021-07-15 19:54:41,256: DEBUG - npm WARN tar ENOENT: no such file or directory, lstat '/var/www/codimd/node_modules/.staging/rxjs-1b0c9ab8/src/operator'
2021-07-15 19:54:41,256: DEBUG - npm WARN tar ENOENT: no such file or directory, open '/var/www/codimd/node_modules/.staging/rxjs-1b0c9ab8/src/operators/zipAll.ts'
2021-07-15 19:54:41,256: DEBUG - npm WARN tar ENOENT: no such file or directory, open '/var/www/codimd/node_modules/.staging/rxjs-1b0c9ab8/src/LICENSE.txt'
2021-07-15 19:54:42,316: DEBUG - npm ERR! err.code.match is not a function
2021-07-15 19:54:42,349: DEBUG - 
2021-07-15 19:54:42,349: DEBUG - npm ERR! A complete log of this run can be found in:
2021-07-15 19:54:42,349: DEBUG - npm ERR!     /root/.npm/_logs/2021-07-15T23_54_42_332Z-debug.log
2021-07-15 19:54:42,366: DEBUG - + ynh_exit_properly

npm logs

Context

• Hardware: dedicated machine
• YunoHost version: version: 4.2.6.1

yunohost app info codimd
description: Collaborative editor to work on notes written in Markdown
domain_path: pad-old.libre.brussels/
name: CodiMD
version: 1.6.0~ynh8

Install fails when login to postgres

On an up-to-date VPS, latest Yunohost version, install fails.

After these two steps:

sudo --login --user=postgres PGUSER=postgres PGPASSWORD=Something psql codimd
sudo --login --user=postgres dropdb codimd

I get:

FATAL: terminating connection due to administrator command
WARNING server closed the connection unexpectedly
WARNING This probably means the server terminated abnormally
WARNING before or while processing the request.
WARNING connection to server was lost

yarn: error: no such option: --pure-lockfile

The installation fails on this error. The fix is here : SemkoDev/field.cli#2

tl:dr : just remove --pure-lockfile, it's now the default.

Install fails

Install fails with this error:

npm install
WARNING npm WARN deprecated [email protected]: Use uuid module instead
WARNING npm WARN deprecated [email protected]: New code is available at github.com/uNetworking/uWebSockets.js
WARNING npm WARN deprecated [email protected]: to-markdown has been renamed to Turndown, with a new API. Please update to turndown v4.0.0 or above and see the migration guide for details: https://github.com/domchristie/turndown/wiki/Migrating-from-to-markdown-to-Turndown

There are additional messages after those ones (I think it's npm error during the uninstall, because of uncomplete install), I can provide them if needed.

Fail2ban support ?

If that app logs failed login attempts (?), we should implement fail2ban to protect logins.

Webpack build fails at 84%

Hi,

The app cannot be installed, webpack build fails at 84% :

2020-05-12 04:34:33,576: WARNING - <s> [webpack.Progress] 84% [0] building 1207/1208 modules 1 active /var/www/codimd/node_modules/viz.js/viz.js
2020-05-12 04:35:03,245: DEBUG - info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
2020-05-12 04:35:03,247: WARNING - Killed
2020-05-12 04:35:03,249: DEBUG - + ynh_exit_properly
2020-05-12 04:35:03,249: WARNING - error Command failed with exit code 137.
2020-05-12 04:35:03,249: DEBUG - + local exit_code=137
2020-05-12 04:35:03,250: DEBUG - + '[' 137 -eq 0 ']'
2020-05-12 04:35:03,250: DEBUG - + trap '' EXIT
2020-05-12 04:35:03,250: DEBUG - + set +eu
2020-05-12 04:35:03,250: DEBUG - + sleep 0.5
2020-05-12 04:35:03,751: DEBUG - + type -t ynh_clean_setup
2020-05-12 04:35:03,751: WARNING - 
2020-05-12 04:35:03,752: DEBUG - + ynh_die
2020-05-12 04:35:03,752: DEBUG - + local legacy_args=mc
2020-05-12 04:35:03,752: DEBUG - + args_array=([m]=message= [c]=ret_code=)
2020-05-12 04:35:03,752: DEBUG - + declare -Ar args_array
2020-05-12 04:35:03,752: DEBUG - + local message
2020-05-12 04:35:03,752: DEBUG - + local ret_code
2020-05-12 04:35:03,752: DEBUG - + ynh_handle_getopts_args
2020-05-12 04:35:03,752: DEBUG - + set +x
2020-05-12 04:35:03,752: DEBUG - + echo ''
2020-05-12 04:35:03,752: DEBUG - + exit 1
2020-05-12 04:35:03,899: ERROR - Impossible d'installer codimd: Une erreur est survenue dans le script d'installation de l'application

WARN: "Browserslist: caniuse-lite is outdated. Please run the following command: `npm update`"

Describe the bug

some strange warnings

Context

• Hardware: VPS bought online
• YunoHost version: 4.2.8.3

Steps to reproduce

install codimd

Expected behavior

installed codimd without these warnings

Logs

Installing codimd...
Validating installation parameters...
Storing installation settings...
Finding an available port...
Installing dependencies...
Configuring system user...
Creating a PostgreSQL database...
Setting up source files...
Configuring NGINX web server...
Building CodiMD... (this will take some time and resources!)
Error verifying phantomjs, continuing { Error: Command failed: /usr/bin/phantomjs --version
qt.qpa.screen: QXcbConnection: Could not connect to display
Could not connect to any X display.
at ChildProcess.exithandler (child_process.js:299:12)
at ChildProcess.emit (events.js:193:13)
at maybeClose (internal/child_process.js:999:16)
at Process.ChildProcess._handle.onexit (internal/child_process.js:266:5)
killed: false,
code: 1,
signal: null,
cmd: '/usr/bin/phantomjs --version' }
npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/fsevents):
npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
Browserslist: caniuse-lite is outdated. Please run the following command: `npm update`
Browserslist: caniuse-lite is outdated. Please run the following command: `npm update`
Browserslist: caniuse-lite is outdated. Please run the following command: `npm update`
Browserslist: caniuse-lite is outdated. Please run the following command: `npm update`
Browserslist: caniuse-lite is outdated. Please run the following command: `npm update`
Browserslist: caniuse-lite is outdated. Please run the following command: `npm update`
Modifying a config file...
Configuring a systemd service...
Integrating service in YunoHost...
Starting a systemd service...
The service codimd has correctly executed the action start.
Configuring permissions...
Reloading NGINX web server...
Installation of CodiMD completed
Installation completed

If applicable and useful, add screenshots to help explain your problem.

Installation fails due to corrupt source (sha256sum)

Describe the bug
Installation fails

Versions

• Hardware: Hetzner, VPS
• YunoHost version: 4.0.8.2
• I have access to my server: Through SSH | through the webadmin
• Are you in a special context or did you perform some particular tweaking on your YunoHost instance ?: no
• Using, or trying to install package version/branch: codimd

To Reproduce
Just install the package.

Expected behavior
Installed codimd.

Logs
https://paste.yunohost.org/raw/aqilepuluy

Add YunoHost package installation in codimd setup doc

As proposed by @SISheogorath

#31 (review)

We should add informations for codimed_ynh doing a PR on https://github.com/codimd/server/tree/master/docs/setup

cp: cannot stat '../conf/.sequelizerc.default': No such file or directory

codimd_ynh/scripts/install

Line 159 in cd594d5

cp ../conf/.sequelizerc.default "$final_path/.sequelizerc"

Install fails on raspberry pi 4 due to invalid nginx config parameter

Describe the bug

Install via the yunohost webadmin ui fails on a raspberry pi 4 (4 GByte RAM) on buster cause an invalid nginx config parameter.
Full log: https://paste.yunohost.org/raw/ewafojehow

Context

• Hardware: Raspberry Pi 4 (4 GByte RAM)
• YunoHost version: 4.3.6.2
• I have access to my server: install tried via webadmin, but then also tried via ssh (see below)
• Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: no

Steps to reproduce

• If you performed a command from the CLI, the command itself is enough. For example:

  sudo yunohost app install codimd

Expected behavior

codimd is installed

Logs

2022-03-05 16:39:53,681: WARNING - Job for nginx.service failed.
2022-03-05 16:39:53,682: WARNING - See "systemctl status nginx.service" and "journalctl -xe" for details.
2022-03-05 16:39:53,684: DEBUG - + ynh_exec_err journalctl --quiet --no-hostname --no-pager --lines=20 --unit=nginx
2022-03-05 16:39:53,684: DEBUG - + [[ 6 -eq 1 ]]
2022-03-05 16:39:53,685: DEBUG - ++ journalctl --quiet --no-hostname --no-pager --lines=20 --unit=nginx
2022-03-05 16:39:53,706: DEBUG - + ynh_print_err 'Mar 05 16:04:44 systemd[1]: Starting A high performance web server and a reverse proxy server...
2022-03-05 16:39:53,707: DEBUG - Mar 05 16:04:47 systemd[1]: Started A high performance web server and a reverse proxy server.
2022-03-05 16:39:53,707: DEBUG - Mar 05 16:17:40 systemd[1]: Reloading A high performance web server and a reverse proxy server.
[...]
2022-03-05 16:39:53,712: DEBUG - Mar 05 16:39:53 nginx[17309]: nginx: [emerg] "proxy_max_temp_file_size" directive invalid value in /etc/nginx/conf.d/pads.maindomain.tld.d/codimd.conf:17
2022-03-05 16:39:53,712: DEBUG - Mar 05 16:39:53 systemd[1]: nginx.service: Control process exited, code=exited, status=1/FAILURE
2022-03-05 16:39:53,713: DEBUG - Mar 05 16:39:53 systemd[1]: Reload failed for A high performance web server and a reverse proxy server.'

Full log: https://paste.yunohost.org/raw/ewafojehow

I can only assume, that on the raspberry the value of 'proxy_max_temp_file_size' of 8192m is too high (it was changed months before from 1024m) - but may be wrong?

Improve app support -> Implement YNH level 4 (up to 7) guidelines

Global issue to track what needs to be done to improve this app, and make it a fully fledged standard Yunohost app.
Forum topic: https://forum.yunohost.org/t/codimd-hackmd-fork-official-topic/11110

To be done (in an approximate order of priority, but any contribution is warmly welcome !):

• Install and removal (level 2): #11 and #19 fixed this, thanks to @alexAubin and @Lab-8916100448256 ! 🎉.
  Still some tests to be done on various configurations…
• Improve install robustness, we should at least look into --line-match for systemd_action to check if service started, otherwise test on the CI may fail because of 502 errors
• Upgrade working (level 3) #22
• Backup&Restore working (level 4) #21
• Set app status to "working" in YNH community.json YunoHost/apps#914
• Handle non domain root install #24
• Level 5 specs
• In Yunohost-Apps repository (Level 6)
• Level 7 specs

Install failure on arm64 due to PhantomJS dependency

Describe the bug

Installing CodiMD fails on arm64 due to a dependency that isn't distributed in the architecture (specifically PhantomJS).

Context

• Hardware: arm64 VPS
• YunoHost version: 11.0.10.1
• I have access to my server: Through SSH and webadmin
• Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: yes
  • If yes, please explain: Running under LXD on a VPS. This shouldn't have any impact on the bug though, it's an issue with the npm package.
• Using, or trying to install package version/branch: 2.4.2~ynh1

Steps to reproduce

Should happen on any arm64 install (ie, sudo yunohost app install codimd). This doesn't happen with HedgeDoc, which installs just fine (and which I didn't know about until looking into related issues).

Logs

Provided here: https://paste.yunohost.org/raw/ekazakugis

It should be noted that PhantomJS has never supplied prebuilt arm64 binaries. Therefore, either it'll need to be built in the script or an alternate binary will need to be found. (Or, instead, this app would be retired and replaced with HedgeDoc...)

Install fails on Bullseye because of a super weird python2 syntax ? wut ?

c.f. https://ci-apps-bullseye.yunohost.org/ci/job/365

39439 INFO [##########+++++++...] > Building CodiMD... (this will take some time and resources!)
78905 WARNING gyp ERR! configure error
78905 WARNING gyp ERR! stack Error: Command failed: /usr/bin/python -c import sys; print "%s.%s.%s" % sys.version_info[:3];
78906 WARNING gyp ERR! stack   File "<string>", line 1
78907 WARNING gyp ERR! stack     import sys; print "%s.%s.%s" % sys.version_info[:3];
78907 WARNING gyp ERR! stack                       ^
78908 WARNING gyp ERR! stack SyntaxError: invalid syntax
78908 WARNING gyp ERR! stack
78956 WARNING gyp ERR! stack     at ChildProcess.exithandler (child_process.js:299:12)
78957 WARNING gyp ERR! stack     at ChildProcess.emit (events.js:193:13)
78957 WARNING gyp ERR! stack     at maybeClose (internal/child_process.js:999:16)
78958 WARNING gyp ERR! stack     at Process.ChildProcess._handle.onexit (internal/child_process.js:266:5)
78958 WARNING gyp ERR! System Linux 5.10.28-scaleway
78959 WARNING gyp ERR! command "/opt/node_n/n/versions/node/11.15.0/bin/node" "/opt/node_n/n/versions/node/11.15.0/lib/node_modules/npm/node_modules/node-gyp/bin/node-gyp.js" "rebuild"
78959 WARNING gyp ERR! cwd /var/www/codimd/node_modules/dtrace-provider
78960 WARNING gyp ERR! node -v v11.15.0
78960 WARNING gyp ERR! node-gyp -v v3.8.0
78960 WARNING gyp ERR! not ok

Calling /usr/bin/python -c import sys; print "%s.%s.%s" % sys.version_info[:3] doesn't work, because print without brackets () is python 2 syntax ... But I don't know why npm/node/gyp would try to call python ...

Maybe moving to a newer version of npm/node/gyp would fix the issue ?

Installation fails : Ineffective mark-compacts near heap limit Allocation failed - JavaScript heap out of memory

Describe the bug

CodiMD installation fails with FATAL ERROR: Ineffective mark-compacts near heap limit Allocation failed - JavaScript heap out of memory
If I understand correctly, the VPS I'm on just lacks ram. I've kept an eye on htop during installation and the 1GB ram got filled, and I think at least part of the swap too.

Versions

• Hardware: Online VPS, 1GB Ram and 256MB swap
• YunoHost version: 3.8.4.9
• I have access to my server: Through SSH and through the Yunohost webadmin
• Are you in a special context or did you perform some particular tweaking on your YunoHost instance ?: no
• Using, or trying to install package version/branch: Trying to install CodiMD 1.6.0~ynh3

To Reproduce
Either from the webadmin or via ssh :

•   sudo yunohost app install codimd

Expected behavior
I hoped the installation would work fine. ^^

Logs
If applicable and useful, add screenshots to help explain your problem.

Full logs here : https://paste.yunohost.org/raw/inekuxewob

Allow to change URL

We need to implement change_url script. https://yunohost.org/#/packaging_apps_scripts

Install Error - Yunohost on Raspberry PI

Trying to install CodiMD on yunohost / raspberry PI 3
( Debian 9.11 - yunohost stable version": "3.6.5.3")

• created dedicated subdomain
• use https://github.com/YunoHost-Apps/codimd_ynh as a source url for the app installation

Got a warning :
"WARNING - yarn: error: no such option: --pure-lockfile"

Extract of log file :

2020-02-17 10:21:19,965: DEBUG - + replace_string=**********
2020-02-17 10:21:19,966: DEBUG - + sudo sed --in-place s@DB_PASS@**********@g ../conf/.sequelizerc.example
2020-02-17 10:21:20,067: DEBUG - + cp ../conf/.sequelizerc.example /var/www/codimd/.sequelizerc
2020-02-17 10:21:20,068: DEBUG - + ynh_script_progression '--message=Building application... (this may take some time and resources!)'
2020-02-17 10:21:20,069: DEBUG - + set +x
2020-02-17 10:21:20,070: DEBUG - + set +x
2020-02-17 10:21:20,071: DEBUG - + echo '! Helper used in legacy mode !'
2020-02-17 10:21:20,072: DEBUG - + set +x
2020-02-17 10:21:20,073: DEBUG - + echo '[#######++...........] > Building application... (this may take some time and resources!)'
2020-02-17 10:21:20,074: DEBUG - + set -x
2020-02-17 10:21:20,075: DEBUG - + pushd /var/www/codimd
2020-02-17 10:21:20,075: DEBUG - /var/www/codimd /var/cache/yunohost/from_file/codimd_ynh-master/scripts
2020-02-17 10:21:20,076: DEBUG - + ./bin/setup
2020-02-17 10:21:20,077: DEBUG - copy config files
2020-02-17 10:21:20,078: DEBUG - install packages
2020-02-17 10:21:21,283: DEBUG - + ynh_exit_properly
2020-02-17 10:21:21,284: WARNING - Usage: yarn [options]
2020-02-17 10:21:21,286: INFO - [#######++...........] > Building application... (this may take some time and resources!)
2020-02-17 10:21:21,288: DEBUG - + local exit_code=2
2020-02-17 10:21:21,288: WARNING -
2020-02-17 10:21:21,290: DEBUG - + '[' 2 -eq 0 ']'
2020-02-17 10:21:21,291: WARNING - yarn: error: no such option: --pure-lockfile
2020-02-17 10:21:21,292: DEBUG - + trap '' EXIT
2020-02-17 10:21:21,293: DEBUG - + set +eu
2020-02-17 10:21:21,293: DEBUG - + sleep 0.5
2020-02-17 10:21:21,796: DEBUG - + ynh_print_err '--message=!!\n codimd'''s script has encountered an error. Its execution was cancelled.\n!!'
2020-02-17 10:21:21,797: DEBUG - + local legacy_args=m
2020-02-17 10:21:21,798: DEBUG - + args_array=([m]=message=)
2020-02-17 10:21:21,800: DEBUG - + declare -Ar args_array
2020-02-17 10:21:21,801: DEBUG - + local message
2020-02-17 10:21:21,802: DEBUG - + ynh_handle_getopts_args '--message=!!\n codimd'''s script has encountered an error. Its execution was cancelled.\n!!'
2020-02-17 10:21:21,804: DEBUG - + set +x
2020-02-17 10:21:21,905: DEBUG - + ynh_print_log '\e[91m\e[1m[ERR]\e[0m !!\n codimd'''s script has encountered an error. Its execution was cancelled.\n!!'
2020-02-17 10:21:21,907: WARNING - �[91m�[1m[ERR]�[0m !!
2020-02-17 10:21:21,912: DEBUG - + echo -e '\e[91m\e[1m[ERR]\e[0m !!\n codimd'''s script has encountered an error. Its execution was cancelled.\n!!'
2020-02-17 10:21:21,913: WARNING - codimd's script has encountered an error. Its execution was cancelled.

Transitionning from CodiMD to HedgeDoc.

A new version 1.7 is coming soon... It is about time to transition this repo.
To do so I have created a new repo : https://github.com/YunoHost-Apps/hedgedoc_ynh that should be good to go as far as naming and links...
@kay0u pointed out the use of a Helper script to migrate files and database from CodiMD to HedgeDoc.
I am wondering if it is worth the effort to implement this...

config.json is overwritten by update

Describe the bug

When updating the application, /var/www/codimd/config.json is overwritten, despite the README file which invites to tweak it.

Versions

• Hardware: Old laptop or computer
• YunoHost version: 4.0.8
• I have access to my server: Through SSH
• Are you in a special context or did you perform some particular tweaking on your YunoHost instance ?: yes
  • If yes, please explain: I changed the value of tooBusyLag because I ofter get a I'm busy right now, try again later. message otherwise.
• Using, or trying to install package version/branch: 1.6.0~ynh4
• If upgrading, current package version: can be found in the admin, or with yunohost app info codimd

To Reproduce

1. Get an old version of Codimd.
2. Add in /var/www/codimd/config.json and in the "production"section the following line: "tooBusyLag": 10000,`
3. Restart the service in order to see the change
4. Upgrade Codimd
5. Check the content of the /var/www/codimd/config.json file

Expected behavior
You should see the "tooBusyLag": 10000, line in the above file

Actual behavior
The line has disappeared.

Install fails because nginx refuses proxy_max_temp_file_size value

Describe the bug

Today a user reported that the install failed with :

nginx: [emerg] "proxy_max_temp_file_size" directive invalid value in /etc/nginx/conf.d/pad.maindomain.tld.d/codimd.conf:21

Corresponding line in nginx.conf : https://github.com/YunoHost-Apps/codimd_ynh/blob/master/conf/nginx.conf#L21

Apparently commenting the line seems to solve the issue ... I'm puzzled on why these lines are necessary (8192m sounds like a lot ?!)

Versions

• Hardware: No idea / this is from another user
• YunoHost version: 3.8.5.4
• I have access to my server: No idea / this is from another user
• Are you in a special context or did you perform some particular tweaking on your YunoHost instance ?: No idea / this is from another user

To Reproduce

Try to install the app ... though not sure where / how to reproduce exactly considering the tests on the CI are passing and so far no other users complained about it

Expected behavior

Instal completing successfully

Logs

https://paste.yunohost.org/raw/nilixeyati

App does not backup uploaded files :sweat:

Hi,

I know this app is deprecated for hedgedoc, but as the repo is open, I still want to point out an (old) bug 😉

It turns out the backups don't include images that are uploaded in the "./public/upload" folder of the app. So after a restore (or the upgrade to hedgedoc), the notes are missing their images, even if the [img] reference is still present in the edit section of the note.

I can provide config details and logs as needed.

Thanks for your feedback, and maybe the issue will be transferred to https://github.com/YunoHost-Apps/hedgedoc_ynh ?

Implement upgrade mechanism

Now that the app can be installed, we should allow our users to upgrade the app (especially because we have no backup script yet 😅).
When backup&restore tools will be implemented, we should implement a backup-before-upgrade tool.

Future of codimd_ynh : hedgedoc vs. hackmd-open-source-edition ?

Following a discussion on the chat, I'm opening this issue :

Turns out that there are currently "two" CodiMD

• The one we ship currently in this app is from https://github.com/codimd/server and currently version 1.6. It's about to be renamed into HedgeDoc
• And there's also https://github.com/hackmdio/codimd currently in version 2.2 and is actually some sort of open source edition (AGPL 3) of HackMD. HackMD being apparently a proprietary software (?) for business/enterprises. (Didn't do so much research)

Related issue about naming if you want to read the whole drama : hackmdio/codimd#1219 ( I haven't really took the time to read the whole thing, the end of the thread seem to suggest the Hack MD team isn't so friendly but would need more time to really have an opinion)

The user I was originally discussing this was interested in hackmd-open-source-edition because it has more features.

Dreaming about it <3

We'd love so much to see it working here at @MailTape for our YH instance <3
Could you share any news on your side regarding shipping please?

kisskiss

Install on / (root) only?

Hi, thanks a lot for packaging codimd, I'd love to use it on ynh.

I tried to install it but it seems to require root installation, preventing other applications to be installed.

Is this a hard limitation? Any wait to circumvent it?

Thanks!