Installation.rst

sudo apt install php-intl
# for file upload, PDF and 'HTML to PDF' (wkhtmltopdf), PDF split
sudo apt install poppler-utils libxrender1 file pdf2svg qpdf ghostscript img2pdf libheif-examples
sudo apt install inkscape imagemagick            # to render thumbnails
mkdir /opt/qfqpdf; cd /opt/qfqpdf
curl -L -o qfqpdf https://www.math.uzh.ch/repo/qfqpdf/current/qfqpdf-linux
chmod a+x qfqpdf
./qfqpdf --version
config.cmdWkhtmltopdf:  /opt/wkhtmltox/bin/wkhtmltopdf
config.baseUrl: http://www.example.com/
config.cmdWkhtmltopdf: LD_LIBRARY_PATH=/opt/wkhtmltox/lib /opt/wkhtmltox/bin/wkhtmltopdf
[FE][lockIP] = 0
<a href="typo3conf/ext/qfq/Classes/Api/print.php?id={current pageId}">Print this page</a>
10 = TEXT
10 {
  wrap = <a href="typo3conf/ext/qfq/Classes/Api/print.php?id=|&type=99"><span class="glyphicon glyphicon-print" aria-hidden="true"></span> Printview</a>
  data = page:uid
}
page.meta {
    X-UA-Compatible = IE=edge
    X-UA-Compatible.attribute = http-equiv
    viewport=width=device-width, initial-scale=1
}

page.includeCSS {
    file01 = typo3conf/ext/qfq/Resources/Public/Css/bootstrap.min.css
    file02 = typo3conf/ext/qfq/Resources/Public/Css/bootstrap-theme.min.css
    file03 = typo3conf/ext/qfq/Resources/Public/Css/qfq-bs.css
    file04 = typo3conf/ext/qfq/Resources/Public/Css/tablesorter-bootstrap.css
    file05 = typo3conf/ext/qfq/Resources/Public/Css/font-awesome.min.css
    file06 = typo3conf/ext/qfq/Resources/Public/Css/bootstrap-datetimepicker.min.css
    file07 = typo3conf/ext/qfq/Resources/Public/Css/codemirror.css

    # Only needed if FullCalendar is used
    file10 = typo3conf/ext/qfq/Resources/Public/Css/fullcalendar.min.css

    # Only needed if FormElement 'upload' filepond is used
    file11 = typo3conf/ext/qfq/Resources/Public/Css/filepond.min.css
}

page.includeJS {
    file01 = typo3conf/ext/qfq/Resources/Public/JavaScript/jquery.min.js
    file02 = typo3conf/ext/qfq/Resources/Public/JavaScript/bootstrap.min.js
    file03 = typo3conf/ext/qfq/Resources/Public/JavaScript/validator.min.js
    file04 = typo3conf/ext/qfq/Resources/Public/JavaScript/tinymce.min.js
    file05 = typo3conf/ext/qfq/Resources/Public/JavaScript/EventEmitter.min.js
    file06 = typo3conf/ext/qfq/Resources/Public/JavaScript/qfq.min.js
    file07 = typo3conf/ext/qfq/Resources/Public/JavaScript/typeahead.bundle.min.js
    file08 = typo3conf/ext/qfq/Resources/Public/JavaScript/jquery.tablesorter.combined.min.js
    file09 = typo3conf/ext/qfq/Resources/Public/JavaScript/jquery.tablesorter.pager.min.js
    file10 = typo3conf/ext/qfq/Resources/Public/JavaScript/widget-columnSelector.min.js
    file11 = typo3conf/ext/qfq/Resources/Public/JavaScript/moment.min.js
    file12 = typo3conf/ext/qfq/Resources/Public/JavaScript/bootstrap-datetimepicker.min.js
    file13 = typo3conf/ext/qfq/Resources/Public/JavaScript/codemirror.min.js
    file14 = typo3conf/ext/qfq/Resources/Public/JavaScript/code-mirror-mode/sql/sql.min.js

    # Only needed if FormElement 'annotate' is used.
    file20 = typo3conf/ext/qfq/Resources/Public/JavaScript/fabric.min.js
    file21 = typo3conf/ext/qfq/Resources/Public/JavaScript/qfq.fabric.min.js

    # Only needed if FullCalendar is used.
    file22 = typo3conf/ext/qfq/Resources/Public/JavaScript/fullcalendar.min.js

    # Only needed if widget-output is used.
    file23 = typo3conf/ext/qfq/Resources/Public/JavaScript/widget-output.min.js

    # Only needed if FormElement 'upload' filepond is used.
    file24 = typo3conf/ext/qfq/Resources/Public/JavaScript/filepond.min.js
    file25 = typo3conf/ext/qfq/Resources/Public/JavaScript/filepond-plugin-file-validate-size.min.js
    file25 = typo3conf/ext/qfq/Resources/Public/JavaScript/filepond-plugin-file-validate-type.min.js
}
dateTimePickerType = qfq
dateTimePickerType = browser
dateTimePickerType = no
file={{file:SU:::_formEditor}}
file=_formEditorTwig
"ENCRYPTION_KEY": "myTestKey"
1. Clarify that your currently used webserver is running with php 8.1 (Ubuntu 22.04) or higher

2. nginx config file adjustments, add following proxy:
   location /ws {
     proxy_pass http://localhost:8090;
     proxy_http_version 1.1;
     proxy_set_header Upgrade $http_upgrade;
     proxy_set_header Connection "upgrade";
     proxy_set_header Host $host;
   }

3. Restart the nginx server

4. Set websocket port and websocket url in QFQ Config, examples:
websocketPort: 8090
websocketUrl: wss://mydomain.com/ws         (wss=ssl/tls, ws=http)

5. If websocketPort is set in qfq config, the websocket server should start automatically the first time a web page with qfq content is loaded.
1. At least Ubuntu 22.04 needs to be installed in docker container. (Usually done inside Dockerfile.nginx):
FROM ubuntu:22.04

1.1 Add the following to the top of your docker file (after FROM ubuntu:22.04) if it does not already exist. It defines the timezone configurations for the ubuntu 22.04 installation:
ENV DEBIAN_FRONTEND=noninteractive
RUN apt-get update && \
    apt-get install -y tzdata && \
    ln -fs /usr/share/zoneinfo/Europe/Zurich /etc/localtime && \
    dpkg-reconfigure --frontend noninteractive tzdata


1.2(optional) If you are using wkhtmltopdf, you will need to manually install libssl1.1 in the docker file before wkhtmltopdf is installed. Reason: libssl1.1 is no longer included in Ubuntu 22.04:
# Manually install libssl1.1
RUN wget http://archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.0g-2ubuntu4_amd64.deb
RUN dpkg -i libssl1.1_1.1.0g-2ubuntu4_amd64.deb

2. Expose the websocket port in the dockerfile (Dockerfile.nginx), it should be added before the services start, example:
EXPOSE 8090
CMD service php8.1-fpm start && service ssh start && nginx


3. Add new websocket port (8090) to nginx webserver in Dockerfile, example:
  nginx:
    image: webserver
    build:
      dockerfile: Dockerfile.nginx
    ports:
      - "46301:46301"
      - "51301:51301"
      - "44909:22"
      - "8090:8090"         <------ Websocket port

4. nginx config file adjustments, add following proxy:
   location /ws {
        proxy_pass http://mydomain:8090;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
    }

5. Start/Restart (Build first time) the docker container.

6. Set the configured websocket port and websocket url in QFQ Config, examples:
websocketPort: 8090
websocketUrl: ws://mydomain:46301/ws

7. If websocketPort is set in qfq config, the websocket server should start automatically the first time a web page with qfq content is loaded.
<?php

/**
QFQ project path configuration
!! ATTENTION !!: The files in the project directory should NOT be served by your http server!
Only exception: The app directory inside the project directory may be served.
*/

return 'fileadmin/protected/qfqProject'; // path relative to app directory (i.e. location of this file).
{
  "DB_1_USER": "<DBUSER>",
  "DB_1_SERVER": "<DBSERVER>",
  "DB_1_PASSWORD": "<DBPW>",
  "DB_1_NAME": "<DB>",

  "DB_2_USER": "<OPTIONAL DBUSER>",
  "DB_2_SERVER": "<OPTIONAL DBSERVER>",
  "DB_2_PASSWORD": "<OPTIONAL DBPW>",
  "DB_2_NAME": "<OPTIONAL DB>",

  "LDAP_1_RDN": "<OPTIONAL> ou=Admin,ou=example,dc=com",
  "LDAP_1_PASSWORD": "<OPTIONAL> mySecurePassword",

  "ENCRYPTION_KEY": "<SECRET KEY>"
}
custom1: ADMINISTRATIVE_CONTACT = john@doe.com
custom2: ADMINISTRATIVE_ADDRESS = John Doe, Hollywood Blvd. 1, L.A.
custom3: ADMINISTRATIVE_NAME = John Doe
{{ADMINISTRATIVE_CONTACT:Y}}, {{ADMINISTRATIVE_ADDRESS:Y}}, {{ADMINISTRATIVE_NAME}}
fillStoreSystemBySql1: SELECT name FROM Person WHERE name='Doe'
fillStoreSystemBySqlErrorMsg1: Too many or to few "Doe's" in our database
fillStoreSystemBySql1: SELECT id AS periodId FROM Period WHERE start<=NOW() ORDER BY start DESC LIMIT 1
SELECT name, ' / ', start FROM Period WHERE id={{periodId:Y0}}
SELECT CONCAT('p:{{pageSlug:T}}?periodId=', {{periodId:SY0}}-1, '|Next') AS _page, ' ', name, ' ',
  CONCAT('p:{{pageSlug:T}}?periodId=', {{periodId:SY0}}+1, '|Next') AS _page FROM Period AS s WHERE s.id={{periodId:SY0}}
fillStoreSystemBySqlRow: SELECT gr.reference AS name, IF('{{pageLanguage:T}}'=0 OR gr.value2='', gr.value, gr.value2) AS value FROM Ggroup AS gr WHERE gr.storeSystem='yes'
{{id_accepted:Y}}
fillStoreSystemBySqlRowErrorMsg: No rows found with given query.
0 19 * * * find /var/www/html/fileadmin/protected/qfqProject/form/.backup/ -type f -mtime +31  -exec rm {} \;