New role for hedgedoc

webapps/hedgedoc/LISEZMOI.md

@@ -0,0 +1,58 @@
+hedgedoc
+=========
+
+Ce rôle installe le serveur de HedgeDoc, une application rédaction collaborative en temps-réel utilisant la syntaxe Markdown. 
+
+Notez qu'hormis le présent fichier LISEZMOI.md, tous les fichiers du rôle hedgedoc sont rédigés en anglais afin de suivre les conventions de la communauté Ansible, favoriser sa réutilisation et son amélioration, etc. Libre à vous cependant de faire appel à ce role dans un playbook rédigé principalement en français ou toute autre langue.
+
+Requis
+------
+
+...
+
+Variables du rôle
+-----------------
+
+Plusieurs des valeurs par défaut dans defaults/main.yml doivent être changées soit directement dans defaults/main.yml ou mieux encore en les supplantant ailleurs, par exemple dans votre playbook (voir l'exemple ci-bas).
+
+Dépendances
+------------
+
+Ce rôle Ansible dépend des rôles suivants :
+
+- nodejs
+
+Exemple de playbook
+-------------------
+
+```
+- name: "Déployer un serveur HedgeDoc"
+  hosts: 
+    - all
+  vars:
+    # Supplanter ici les variables du rôle
+    domains: ['votre-vrai-domaine.org']
+    service: 'mon-hedgedoc'
+    db_host: 'localhost'
+    db_user: "{{ service }}"
+    db_name: "{{ service }}"
+    db_password: 'zKEh-CHANGEZ-MOI-qIKc'
+
+  pre_tasks:
+    - name: "Installer les rôles systèmes"
+      roles:
+        - { role: nodejs, nodejs_apt_version: 'node_16.x', nodejs_install_yarn: True }
+
+  roles:
+    - { role: webapps/hedgedoc , tags: "hedgedoc" }
+```
+
+Licence
+-------
+
+GPLv3
+
+Infos sur l'auteur
+------------------
+
+Mathieu Gauthier-Pilote, administrateur de systèmes chez Evolix.

webapps/hedgedoc/README.md

@@ -0,0 +1,58 @@
+hedgedoc
+=========
+
+This role installs or upgrades the server for the real-time markdown collaborative editor HedgeDoc. 
+
+FRENCH: Voir le fichier LISEZMOI.md pour le français.
+
+Requirements
+------------
+
+...
+
+Role Variables
+--------------
+
+Several of the default values in defaults/main.yml must be changed either directly in defaults/main.yml or better even by overwriting them somewhere else, for example in your playbook (see the example below).
+
+Dependencies
+------------
+
+This Ansible role depends on the following other roles:
+
+- nodejs
+
+Example Playbook
+----------------
+
+```
+- name: "Deploy a HedgeDoc server"
+  hosts: 
+    - all
+  vars:
+    # Overwrite the role variable here
+    domains: ['your-real-domain.org']
+    service: 'my-hedgedoc'
+    db_host: 'localhost'
+    db_user: "{{ service }}"
+    db_name: "{{ service }}"
+    db_password: 'zKEh-CHANGE-ME-qIKc'
+
+  pre_tasks:
+    - name: "Install system roles"
+      roles:
+        - { role: nodejs, nodejs_apt_version: 'node_16.x', nodejs_install_yarn: True }
+
+  roles:
+    - { role: webapps/hedgedoc , tags: "hedgedoc" }
+```
+
+License
+-------
+
+GPLv3
+
+Author Information
+------------------
+
+Mathieu Gauthier-Pilote, sys. admin. at Evolix.

webapps/hedgedoc/defaults/main.yml

@@ -0,0 +1,14 @@
+---
+# defaults file for mastodon
+system_dep: "['apt-transport-https', 'postgresql', 'python3-psycopg2', 'nginx', 'git', 'wget', 'certbot']"
+git_url: 'https://github.com/hedgedoc/hedgedoc.git'
+git_version: '1.9.6'
+node_version: 'node_16.x'
+node_port: '3000'
+service: 'example'
+domains: ['example.domain.org']
+
+db_host: 'localhost'
+db_user: "{{ service }}"
+db_name: "{{ service }}"
+db_password: 'CHANGE_ME'

webapps/hedgedoc/handlers/main.yml

@@ -0,0 +1,2 @@
+---
+# handlers file for mastodon

webapps/hedgedoc/meta/main.yml

@@ -0,0 +1,52 @@
+galaxy_info:
+  author: Mathieu Gauthier-Pilote
+  description: sys. admin.
+  company: Evolix
+
+  # If the issue tracker for your role is not on github, uncomment the
+  # next line and provide a value
+  # issue_tracker_url: http://example.com/issue/tracker
+
+  # Choose a valid license ID from https://spdx.org - some suggested licenses:
+  # - BSD-3-Clause (default)
+  # - MIT
+  # - GPL-2.0-or-later
+  # - GPL-3.0-only
+  # - Apache-2.0
+  # - CC-BY-4.0
+  license: license GPL-3.0-only
+
+  min_ansible_version: 2.10
+
+  # If this a Container Enabled role, provide the minimum Ansible Container version.
+  # min_ansible_container_version:
+
+  #
+  # Provide a list of supported platforms, and for each platform a list of versions.
+  # If you don't wish to enumerate all versions for a particular platform, use 'all'.
+  # To view available platforms and versions (or releases), visit:
+  # https://galaxy.ansible.com/api/v1/platforms/
+  #
+  # platforms:
+  # - name: Fedora
+  #   versions:
+  #   - all
+  #   - 25
+  # - name: SomePlatform
+  #   versions:
+  #   - all
+  #   - 1.0
+  #   - 7
+  #   - 99.99
+
+  galaxy_tags: []
+    # List tags for your role here, one per line. A tag is a keyword that describes
+    # and categorizes the role. Users find roles by searching for tags. Be sure to
+    # remove the '[]' above, if you add tags to this list.
+    #
+    # NOTE: A tag is limited to a single word comprised of alphanumeric characters.
+    #       Maximum 20 tags per role.
+
+dependencies: []
+  # List your role dependencies here, one per line. Be sure to remove the '[]' above,
+  # if you add dependencies to this list.

webapps/hedgedoc/tasks/main.yml

@@ -0,0 +1,123 @@
+---
+# tasks file for hedgedoc install
+
+- name: Install main system dependencies
+  apt:
+    name: "{{ system_dep }}"
+
+- name: Install node-gyp from yarn
+  shell: npm install --global node-gyp
+
+- name: Add UNIX account
+  user:
+    name: "{{ service }}"
+    shell: /bin/bash
+
+- name: Add PostgreSQL user
+  postgresql_user:
+    name: "{{ db_user }}"
+    password: "{{ db_password }}"
+    no_password_changes: true
+  become_user: postgres
+
+- name: Add PostgreSQL database
+  postgresql_db:
+    name: "{{ db_name }}"
+    owner: "{{ db_user }}"
+  become_user: postgres
+
+- block:
+  - name: Clone hedgedoc repo (git)
+    git:
+      repo: "{{ git_url }}"
+      dest: "~/hedgedoc/"
+      version: "{{ git_version | default(omit) }}"
+      update: yes
+      umask: '0022'
+  - name: Run setup
+    shell: "bin/setup"
+    args:
+      chdir: "~/hedgedoc"
+  - name: Install dependencies for frontend app
+    shell: "yarn install --frozen-lockfile"
+    args:
+      chdir: "~/hedgedoc"
+  - name: Build frontend app
+    shell: "yarn build"
+    args:
+      chdir: "~/hedgedoc"
+  become_user: "{{ service }}"
+
+- name: Template json config file
+  template:
+    src: "config.json.j2"
+    dest: "~{{ service }}/hedgedoc/config.json"
+    owner: "{{ service }}"
+    group: "{{ service }}"
+    mode: "0640"
+
+- name: Add systemd unit
+  template:
+    src: "hedgedoc.service.j2"
+    dest: "/etc/systemd/system/{{ service }}.service"
+
+- name: Enable systemd units
+  systemd:
+    name: "{{ service }}.service"
+    enabled: yes
+    daemon_reload: yes
+
+- name: Start service
+  service:
+    name: "{{ service }}.service"
+    state: started
+
+- name: Check if SSL certificate is present and register result
+  stat:
+    path: "/etc/letsencrypt/live/{{ domains |first }}/fullchain.pem"
+  register: ssl
+
+- name: Generate certificate only if required (first time)
+  block:
+  - name: Template vhost without SSL for successfull LE challengce
+    template: 
+      src: "vhost.j2"
+      dest: "/etc/nginx/sites-available/{{ service }}"
+  - name: Enable temporary nginx vhost for LE
+    file:
+      src: "/etc/nginx/sites-available/{{ service }}"
+      dest: "/etc/nginx/sites-enabled/{{ service }}"
+      state: link
+  - name: Reload nginx conf
+    service:
+      name: nginx
+      state: reloaded
+  - name: Make sure /var/lib/letsencrypt exists and has correct permissions
+    file: 
+      path: /var/lib/letsencrypt
+      state: directory
+      mode: '0755'
+#  - name: Generate certificate with certbot
+#    shell: certbot certonly --webroot --webroot-path /var/lib/letsencrypt -d {{ domains |first }}
+  when: ssl.stat.exists == false
+
+- name: (Re)check if SSL certificate is present and register result
+  stat:
+    path: "/etc/letsencrypt/live/{{ domains |first }}/fullchain.pem"
+  register: ssl
+
+- name: (Re)template conf file for nginx vhost with SSL
+  template:
+    src: "vhost.j2"
+    dest: "/etc/nginx/sites-available/{{ service }}"
+
+- name: Enable nginx vhost for hedgedoc
+  file:
+    src: "/etc/nginx/sites-available/{{ service }}"
+    dest: "/etc/nginx/sites-enabled/{{ service }}"
+    state: link
+
+- name: Reload nginx conf
+  service:
+    name: nginx
+    state: reloaded

webapps/hedgedoc/tasks/upgrade.yml

@@ -0,0 +1,57 @@
+---
+# tasks file for hedgedoc upgrade
+
+- name: Dump database to a file with compression
+  postgresql_db:
+    name: "{{ service }}"
+    state: dump
+    target: "~/{{ service }}.sql.gz"
+  become_user: postgres
+
+- name: Stop service
+  service:
+    name: "{{ service }}.service"
+    state: stopped
+
+- block:
+  - name: Clone hedgedoc repo (git)
+    git:
+      repo: "{{ git_url }}"
+      dest: "~/hedgedoc/"
+      version: "{{ git_version }}"
+      update: yes
+  - name: Run setup
+    shell: "bin/setup"
+    args:
+      chdir: "~/hedgedoc"
+  - name: Install dependencies for frontend app
+    shell: "yarn install --frozen-lockfile"
+    args:
+      chdir: "~/hedgedoc"
+  - name: Build frontend app
+    shell: "yarn build"
+    args:
+      chdir: "~/hedgedoc"
+  become_user: "{{ service }}"
+
+- name: Restart services
+  service:
+    name: "{{ service }}.service"
+    state: restarted
+
+- name: Define variable to skip next task by default
+  set_fact:
+    keep_db_dump: true
+
+- name: Remove database dump
+  file:
+    path: "~/{{ service }}.sql.gz"
+    state: absent
+  become_user: postgres
+  when: keep_db_dump is undefined
+  tags: clean
+
+- name: Reload nginx conf
+  service:
+    name: nginx
+    state: reloaded

webapps/hedgedoc/templates/config.json.j2

@@ -0,0 +1,46 @@
+{
+    "test": {
+        "db": {
+            "dialect": "sqlite",
+            "storage": ":memory:"
+        },
+        "linkifyHeaderStyle": "gfm"
+    },
+    "development": {
+        "loglevel": "debug",
+        "db": {
+            "dialect": "sqlite",
+            "storage": "./db.hedgedoc.sqlite"
+        },
+        "domain": "localhost",
+        "urlAddPort": true
+    },
+    "production": {
+        "domain": "{{ domains }}",
+        "loglevel": "info",
+        "protocolUseSSL": "true",
+        "urlAddPort": false,
+        "hsts": {
+            "enable": true,
+            "maxAgeSeconds": 31536000,
+            "includeSubdomains": true,
+            "preload": true
+        },
+        "csp": {
+            "enable": true,
+            "directives": {
+            },
+            "upgradeInsecureRequests": "auto",
+            "addDefaults": true
+        },
+        "cookiePolicy": "lax",
+        "db": {
+            "username": "{{ db_user }}",
+            "password": "{{ db_password }}",
+            "database": "{{ db_name }}",
+            "host": "{{ db_host }}",
+            "port": "5432",
+            "dialect": "postgres"
+        }
+    }
+}

webapps/hedgedoc/templates/hedgedoc.service.j2

@@ -0,0 +1,46 @@
+[Unit]
+Description=HedgeDoc - The best platform to write and share markdown.
+Documentation=https://docs.hedgedoc.org/
+After=network.target
+# Uncomment if you use MariaDB/MySQL
+# After=mysql.service
+# Uncomment if you use PostgreSQL
+After=postgresql.service
+
+[Service]
+Type=exec
+Environment=NODE_ENV=production
+Restart=always
+RestartSec=2s
+ExecStart=/usr/bin/yarn start --production
+CapabilityBoundingSet=
+NoNewPrivileges=true
+PrivateDevices=true
+RemoveIPC=true
+LockPersonality=true
+ProtectControlGroups=true
+ProtectKernelTunables=true
+ProtectKernelModules=true
+ProtectKernelLogs=true
+ProtectClock=true
+ProtectHostname=true
+ProtectProc=noaccess
+RestrictRealtime=true
+RestrictSUIDSGID=true
+RestrictNamespaces=true
+RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6
+ProtectSystem=strict
+PrivateTmp=true
+SystemCallArchitectures=native
+SystemCallFilter=@system-service
+
+# You may have to adjust these settings
+User={{service}}
+Group={{service}}
+WorkingDirectory=/home/{{service}}/hedgedoc
+
+# Example: local storage for uploads and SQLite
+# ReadWritePaths=/opt/hedgedoc/public/uploads /opt/hedgedoc/db
+
+[Install]
+WantedBy=multi-user.target

webapps/hedgedoc/templates/vhost.j2

@@ -0,0 +1,49 @@
+map $http_upgrade $connection_upgrade {
+    default upgrade;
+    ''      close;
+}
+
+server {
+  listen 80;
+  listen [::]:80;
+  server_name {{ domains |first }};
+  
+  # For Let's Encrypt
+  location /.well-known/acme-challenge/ { allow all; }
+
+  {% if ssl.stat.exists %}
+  location / { return 301 https://$host$request_uri; }
+  {% endif %}
+}
+
+{% if ssl.stat.exists %}
+server {
+  listen 443 ssl http2;
+  listen [::]:443 ssl http2;
+  server_name {{ domains |first }};
+
+  # For Let's Encrypt
+  location /.well-known/acme-challenge/ { allow all; }
+  ssl_certificate /etc/letsencrypt/live/{{ domains |first }}/fullchain.pem;
+  ssl_certificate_key /etc/letsencrypt/live/{{ domains |first }}/privkey.pem;
+  ssl_trusted_certificate /etc/letsencrypt/live/{{ domains |first }}/chain.pem;
+
+  location / {
+      proxy_pass http://127.0.0.1:{{ node_port }};
+      proxy_set_header Host $host; 
+      proxy_set_header X-Real-IP $remote_addr; 
+      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 
+      proxy_set_header X-Forwarded-Proto $scheme;
+  }
+
+  location /socket.io/ {
+      proxy_pass http://127.0.0.1:{{ node_port }};
+      proxy_set_header Host $host; 
+      proxy_set_header X-Real-IP $remote_addr; 
+      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 
+      proxy_set_header X-Forwarded-Proto $scheme;
+      proxy_set_header Upgrade $http_upgrade;
+      proxy_set_header Connection $connection_upgrade;
+  } 
+}
+{% endif %}

webapps/hedgedoc/tests/inventory

@@ -0,0 +1,2 @@
+localhost
+

webapps/hedgedoc/tests/test.yml

@@ -0,0 +1,5 @@
+---
+- hosts: localhost
+  remote_user: root
+  roles:
+    - hedgedoc

webapps/hedgedoc/vars/main.yml

@@ -0,0 +1,2 @@
+---
+# vars file