HedgeDoc installieren: Unterschied zwischen den Versionen

Aus Hostsharing Wiki
Zur Navigation springen Zur Suche springen
K (Tim00 verschob die Seite CodiMD installieren nach HedgeDoc installieren: Umbenennung des Projektes)
(Aktualisierung, Ersetzung HedgeDoc, Anpassung Installation)
Zeile 1: Zeile 1:
= CodiMD installieren =
= HedgeDoc installieren =


'''CodiMD''' ist ein Online-Texteditor für das gemeinschaftliche Bearbeiten von Texten. Die Texte können mit Hilfe von Markdown mit Hervorhebungen und Gliederung gestaltet werden.
'''HedgeDoc''' ist ein Online-Texteditor für das gemeinschaftliche Bearbeiten von Texten. Die Texte können mit Hilfe von Markdown mit Hervorhebungen und Gliederung gestaltet werden.


[[Datei:Codimd-screen.png|720px]]
[[Datei:Codimd-screen.png|720px]]


CodiMD ist eine moderne Alternative zum [[Etherpad_Installieren|Etherpad]].
[https://hedgedoc.org/ HedgeDoc] ist eine moderne Alternative zum [[Etherpad_Installieren|Etherpad]].


Mittlerweile ist das Projekt umbenannt in [https://hackmd.io HackMD]. [https://hedgedoc.org/ HedgeDoc] ist ein Fork des Projekts.
Das Projekt hieß auch mal CodiMD und HackMD, die Geschichte ist hier nachzulesen: https://hedgedoc.org/history/


== Vorbereitungen in HSAdmin ==
== Vorbereitungen in HSAdmin ==
Zeile 13: Zeile 13:
Nach des Hostsharing "best practice" soll für jede Anwendung eine eigene (Sub-)domain unter einem eigenen User geschaltet werden. Eine eigene Datenbank versteht sich von selbst...
Nach des Hostsharing "best practice" soll für jede Anwendung eine eigene (Sub-)domain unter einem eigenen User geschaltet werden. Eine eigene Datenbank versteht sich von selbst...


CodiMD unterstützt unter anderem PostgreSQL als Datenbank, so dass wir hier eine Postgres-Datenbank verwenden.
HedgeDoc unterstützt unter anderem PostgreSQL als Datenbank, so dass wir hier eine Postgres-Datenbank verwenden.


Als Paketadmin ''xyz00'' aufrufen:<pre>hsscript -i</pre>
Als Paketadmin ''xyz00'' aufrufen:<pre>hsscript -i</pre>
Zeile 20: Zeile 20:


<pre>
<pre>
xyz00@hsadmin> user.add({set:{name:'xyz00-codimd', password:'mein-Geheimwort', shell:'/bin/bash'}})
xyz00@hsadmin> user.add({set:{name:'xyz00-hedgedoc', password:'mein-Geheimwort', shell:'/bin/bash'}})
xyz00@hsadmin> domain.add({set:{name:'md.hs-example.de', user:'xyz00-codimd'}})
xyz00@hsadmin> domain.add({set:{name:'hedgedoc.hs-example.de', user:'xyz00-hedgedoc'}})
xyz00@hsadmin> postgresqluser.add({set:{name:'xyz00_codimd', password:'anderes-Geheimwort'}})
xyz00@hsadmin> postgresqluser.add({set:{name:'xyz00_hedgedoc', password:'anderes-Geheimwort'}})
xyz00@hsadmin> postgresqldb.add({set:{name:'xyz00_codimd', owner:'xyz00_codimd'}})
xyz00@hsadmin> postgresqldb.add({set:{name:'xyz00_hedgedoc', owner:'xyz00_hedgedoc'}})
xyz00@hsadmin> bye
xyz00@hsadmin> bye
</pre>
</pre>
Zeile 29: Zeile 29:
== Voraussetzungen installieren ==
== Voraussetzungen installieren ==


Etherpad benötigt ''nodejs'' in einer Version > 10.x. Die Installation erfolgt gemäss der Wiki-Anleitung: [[NodeJS]]
HedgeDoc benötigt ''nodejs'' in einer Version >= 16.x. Die Installation erfolgt gemäss der Wiki-Anleitung: [[NodeJS]]


Als neu angelegter User ''xyz00-codimd'':
Als neu angelegter User ''xyz00-hedgedoc'':


<pre>
<pre>
Zeile 47: Zeile 47:
</pre>
</pre>


Dann wieder als User ''xyz00-codimd'' anmelden:
Dann wieder als User ''xyz00-hedgedoc'' anmelden:


<pre>
<pre>
Zeile 56: Zeile 56:
Damit sind ''yarn'' und ''node'' installiert.
Damit sind ''yarn'' und ''node'' installiert.


== CodiMD installieren ==
== HedgeDoc installieren ==


Weiter als User ''xyz00-codimd'':
Weiter als User ''xyz00-hedgedoc'':


<pre>
<pre>
     cd
     cd
     git clone https://github.com/codimd/server.git codimd
     git clone https://github.com/hedgedoc/hedgedoc.git hedgedoc
     cd codimd
     cd hedgedoc
     git checkout 1.6.0    // aktuelle Version auswählen, heute (im Mai 2020) ist das 1.6.0
     git checkout 1.6.0    // aktuelle Version auswählen, heute (im Juni 2022) ist das 1.9.3
    source ~/.profile
     ./bin/setup
     ./bin/setup
    yarn install --frozen-lockfile
    yarn build
</pre>
</pre>


An dieser Stelle werden die Dateien ''config.json'' und ''.sequelizerc'' angepasst.
An dieser Stelle wird die Datei ''config.json'' angepasst.


Meine ''config.json'':
Meine ''config.json'':
Zeile 75: Zeile 78:
     {
     {
         "production": {
         "production": {
             "domain": "md.hs-example.de",
             "domain": "hedgedoc.hs-example.de",
             "loglevel": "info",
             "loglevel": "info",
             "hsts": {
             "hsts": {
Zeile 93: Zeile 96:
             },
             },
             "db": {
             "db": {
                 "username": "xyz00_codimd",
                 "username": "xyz00_hedgedoc",
                 "password": "anderes-Geheimwort",
                 "password": "anderes-Geheimwort",
                 "database": "xyz00_codimd",
                 "database": "xyz00_hedgedoc",
                 "host": "localhost",
                 "host": "localhost",
                 "port": "5432",
                 "port": "5432",
Zeile 105: Zeile 108:
         }
         }
     }
     }
</pre>
In der Datei ''.sequelizerc'' wird noch einmal die Datenbank definiert:
<pre>
    var path = require('path');
    module.exports = {
        'config':          path.resolve('config.json'),
        'migrations-path': path.resolve('lib', 'migrations'),
        'models-path':    path.resolve('lib', 'models'),
        'url':            'postgres://xyz00_codimd:anderes-Geheimwort@localhost:5432/xyz00_codimd'
}
</pre>
</pre>


Zeile 122: Zeile 113:


<pre>
<pre>
     cd $HOME/codimd
     cd $HOME/hedgedoc
     npm start --production
     npm start --production
</pre>
</pre>
Zeile 134: Zeile 125:
<pre>
<pre>
     cd
     cd
     cd doms/md.hs-example.de
     cd doms/hedgedoc.hs-example.de
     rm -rf subs/www subs-ssl/www app-ssl htdocs-ssl
     rm -rf subs/www subs-ssl/www app-ssl htdocs-ssl
     ln -s $HOME/codimd app-ssl
     ln -s $HOME/hedgedoc app-ssl
     ln -s $HOME/codimd/public htdocs-ssl
     ln -s $HOME/hedgedoc/public htdocs-ssl
     echo "PassengerNodejs $(which node)" >.htaccess
     echo "PassengerNodejs $(which node)" >.htaccess
</pre>
</pre>


Die Anwendung ist unter ''https://md.hs-example.de'' erreichbar.
Die Anwendung ist unter ''https://hedgedoc.hs-example.de'' erreichbar.


== Links ==
== Links ==


* https://demo.codimd.org/s/features
* https://demo.hedgedoc.org/s/features
* https://github.com/codimd/server
* https://github.com/hedgedoc/hedgedoc/releases
* https://github.com/codimd/server/blob/master/docs/setup/manual-setup.md
* https://docs.hedgedoc.org/setup/manual-setup/


----
----

Version vom 16. Juni 2022, 12:56 Uhr

HedgeDoc installieren

HedgeDoc ist ein Online-Texteditor für das gemeinschaftliche Bearbeiten von Texten. Die Texte können mit Hilfe von Markdown mit Hervorhebungen und Gliederung gestaltet werden.

Codimd-screen.png

HedgeDoc ist eine moderne Alternative zum Etherpad.

Das Projekt hieß auch mal CodiMD und HackMD, die Geschichte ist hier nachzulesen: https://hedgedoc.org/history/

Vorbereitungen in HSAdmin

Nach des Hostsharing "best practice" soll für jede Anwendung eine eigene (Sub-)domain unter einem eigenen User geschaltet werden. Eine eigene Datenbank versteht sich von selbst...

HedgeDoc unterstützt unter anderem PostgreSQL als Datenbank, so dass wir hier eine Postgres-Datenbank verwenden.

Als Paketadmin xyz00 aufrufen:

hsscript -i

In der HSAdmin-Shell gibt man dann ein:

xyz00@hsadmin> user.add({set:{name:'xyz00-hedgedoc', password:'mein-Geheimwort', shell:'/bin/bash'}})
xyz00@hsadmin> domain.add({set:{name:'hedgedoc.hs-example.de', user:'xyz00-hedgedoc'}})
xyz00@hsadmin> postgresqluser.add({set:{name:'xyz00_hedgedoc', password:'anderes-Geheimwort'}})
xyz00@hsadmin> postgresqldb.add({set:{name:'xyz00_hedgedoc', owner:'xyz00_hedgedoc'}})
xyz00@hsadmin> bye

Voraussetzungen installieren

HedgeDoc benötigt nodejs in einer Version >= 16.x. Die Installation erfolgt gemäss der Wiki-Anleitung: NodeJS

Als neu angelegter User xyz00-hedgedoc:

    cd
    touch .profile
    chmod u+x .profile 
    mkdir tmp
    cd tmp/
    wget https://raw.githubusercontent.com/creationix/nvm/v0.35.3/install.sh
    chmod u+x install.sh 
    ./install.sh 
    cd ..
    rm tmp/install.sh 
    exit

Dann wieder als User xyz00-hedgedoc anmelden:

    npm install -g yarn
    nvm install 10

Damit sind yarn und node installiert.

HedgeDoc installieren

Weiter als User xyz00-hedgedoc:

    cd
    git clone https://github.com/hedgedoc/hedgedoc.git hedgedoc
    cd hedgedoc
    git checkout 1.6.0    // aktuelle Version auswählen, heute (im Juni 2022) ist das 1.9.3
    source ~/.profile
    ./bin/setup
    yarn install --frozen-lockfile
    yarn build

An dieser Stelle wird die Datei config.json angepasst.

Meine config.json:

    {
        "production": {
            "domain": "hedgedoc.hs-example.de",
            "loglevel": "info",
            "hsts": {
                "enable": true,
                "maxAgeSeconds": 31536000,
                "includeSubdomains": true,
                "preload": true
            },
            "csp": {
                "enable": true,
                "directives": {
                },
                "upgradeInsecureRequests": "auto",
                "addDefaults": true,
                "addDisqus": false,
                "addGoogleAnalytics": false
            },
            "db": {
                "username": "xyz00_hedgedoc",
                "password": "anderes-Geheimwort",
                "database": "xyz00_hedgedoc",
                "host": "localhost",
                "port": "5432",
                "dialect": "postgres"
            },
            "protocolUseSSL": true,
            "allowPDFExport": true,
            "linkifyHeaderStyle": "gfm"
        }
    }

Die Anwendung testweise starten:

    cd $HOME/hedgedoc
    npm start --production

Die Anwendung sollte fehlerfrei starten und die Datenbank initialisieren. Sie ist unter http://xyz00.hostsharing.net:3000 erreichbar.

Mit Ctrl-C abbrechen.

Apache und Passenger konfigurieren

    cd
    cd doms/hedgedoc.hs-example.de
    rm -rf subs/www subs-ssl/www app-ssl htdocs-ssl
    ln -s $HOME/hedgedoc app-ssl
    ln -s $HOME/hedgedoc/public htdocs-ssl
    echo "PassengerNodejs $(which node)" >.htaccess

Die Anwendung ist unter https://hedgedoc.hs-example.de erreichbar.

Links