InGrid Editor

Allgemeines¶

Der InGrid Editor ermöglicht die Erfassung von Metadaten über vielseitige Formulare und bietet einen umfangreichen Workflow, der den Import sowie den Export verschiedener Formate erlaubt.

Insbesondere wird die Erfassung und Publizierung von ISO 19115/19119, OGC, INSPIRE und DCAT-AP.DE konformen Metadaten unterstützt.

Leitfaden¶

Sie haben die Installation bereits abgeschlossen? Dieser Leitfaden könnte Sie interessieren.

Systemvoraussetzungen¶

Installation¶

Docker¶

services:

  editor:
    image: registry.opencode.de/informationgrid/ingrid-editor
    restart: unless-stopped
    depends_on:
      - postgres-db
    environment:
      - _JAVA_OPTIONS=-Xmx2g -Dstorage.diskCache.bufferSize=256 -Dspring.profiles.active=ingrid
      - DATABASE_HOST=postgres-db
      - DATABASE_USERNAME=${POSTGRES_DB_ADMIN}
      - DATABASE_PASSWORD=${POSTGRES_DB_PASSWORD}
      - KEYCLOAK_URL=http://keycloak:8080/keycloak
      - KEYCLOAK_URL_FRONTEND=http://${HOST}/keycloak
      - KEYCLOAK_BACKEND_USER=${KEYCLOAK_ADMIN}
      - KEYCLOAK_BACKEND_USER_PASSWORD=${KEYCLOAK_PASSWORD}
    ports:
      - "8080:8080"
    networks:
      - informationgrid-network

services:

  postgres-db:
    image: postgres:17.4
    restart: unless-stopped
    environment:
      - POSTGRES_USER=${POSTGRES_DB_ADMIN}
      - POSTGRES_PASSWORD=${POSTGRES_DB_PASSWORD}
    volumes:
      - ./_data/postgres-db/:/var/lib/postgresql/data
    networks:
      - informationgrid-network

  elastic:
    image: docker.elastic.co/elasticsearch/elasticsearch:8.18.0
    restart: unless-stopped
    environment:
      - cluster.name=ingrid
      - discovery.type=single-node
      - cluster.routing.allocation.disk.threshold_enabled=false
      - http.host=0.0.0.0
      - transport.host=0.0.0.0
      - http.cors.enabled=true
      - "ES_JAVA_OPTS=-Xmx2g"
      - xpack.security.enabled=false
    volumes:
      - ./_data/elasticsearch_data:/usr/share/elasticsearch/data
    networks:
      - informationgrid-network

  keycloak:
    image: docker-registry.wemove.com/keycloak
    restart: unless-stopped
    environment:
      - KC_BOOTSTRAP_ADMIN_USERNAME=admin
      - KC_BOOTSTRAP_ADMIN_PASSWORD=admin
      - KC_HTTP_RELATIVE_PATH=/keycloak
      - KC_HOSTNAME=http://${HOST}/keycloak
      - KC_HTTP_ENABLED=true
      - KC_PROXY_HEADERS=xforwarded
      - KC_DB=postgres
      - KC_DB_URL_HOST=postgres-db
      - KC_DB_USERNAME=${POSTGRES_DB_ADMIN}
      - KC_DB_PASSWORD=${POSTGRES_DB_PASSWORD}
      - MAIL_SMTP=mailrelay
      - IGE_SUPER_USER_LOGIN=ige
      - IGE_SUPER_USER_PASSWORD=admin
      - IGE_SUPER_USER_FIRSTNAME=Super
      - IGE_SUPER_USER_LASTNAME=User
      - IGE_SUPER_USER_EMAIL=Super.User@test.com
    networks:
      - informationgrid-network

  editor:
    image: registry.opencode.de/informationgrid/ingrid-editor
    restart: unless-stopped
    depends_on:
      - postgres-db
    environment:
      - _JAVA_OPTIONS=-Xmx2g -Dstorage.diskCache.bufferSize=256 -Dspring.profiles.active=ingrid
      - DATABASE_HOST=postgres-db
      - DATABASE_USERNAME=${POSTGRES_DB_ADMIN}
      - DATABASE_PASSWORD=${POSTGRES_DB_PASSWORD}
      - KEYCLOAK_URL=http://keycloak:8080/keycloak
      - KEYCLOAK_URL_FRONTEND=http://${HOST}/keycloak
      - KEYCLOAK_BACKEND_USER=${KEYCLOAK_ADMIN}
      - KEYCLOAK_BACKEND_USER_PASSWORD=${KEYCLOAK_PASSWORD}
    ports:
      - "8080:8080"
    networks:
      - informationgrid-network

In einer weiteren Datei .env werden die Variablen für die docker-compose.yml Datei gesetzt.

RPM¶

Installieren Sie das RPM über den folgenden Befehl:

sudo dnf install ingrid-editor

Der InGrid-Editor verwendet eine PostgreSQL-Datenbank, die vor dem Start vorhanden sein muss. Erstellen Sie die bereits vorkonfigurierte Datenbank mit dem folgenden Befehl:

sudo -u postgres psql -c "CREATE DATABASE ige;"

Stellen Sie sicher, dass dem Datenbankbenutzer die Rechte für die neu erstellte Datenbank korrekt gesetzt sind. Passen Sie die Umgebungsvariablen für den Editor in der Datei /etc/sysconfig/ingrid-editor an. Dabei sind vor allem die Einstellungen für die Datenbank und Keycloak wichtig. Für die weitere Konfiguration schauen Sie bitte die verfügbaren Umgebungsvariablen an. Außerdem können Sie alle Einstellungen auch in der Datei /opt/ingrid/ingrid-editor/config/application.properties vornehmen, allerdings empfehlen wir die Konfiguration über Umgebungsvariablen.

Starten Sie danach den InGrid Editor über den folgenden Befehl:

sudo systemctl start ingrid-editor

# wenn automatisch gestartet werden soll beim Neustart des Systems
sudo systemctl enable ingrid-editor

From Source¶

Um den InGrid-Editor direkt auf einem System zu installieren, müssen folgende zusätzliche Vorbedingungen erfüllt sein:

• NodeJS (>= v22)

Die Installation des InGrid-Editors (z.B. nach /opt/ingrid/ingrid-editor) erfolgt dann mit diesen Schritten:

Editor klonen und bauen¶

git clone https://github.com/informationgrid/ingrid-editor
cd ingrid-editor/frontend
yarn
cd ..
./gradlew -PbuildProfile=prod build -x test -x check

Editor installieren¶

unzip -qq "build/distributions/ingrid-editor-[0-9]*.zip" -d /tmp/editor
mkdir -p /opt/ingrid/ingrid-editor
mv /tmp/editor/ingrid-editor-*/* /opt/ingrid/ingrid-editor
cp -r frontend/build/dist/browser/* /opt/ingrid/ingrid-editor/webapp/static

Editor starten¶

Bevor Sie den InGrid-Editor starten, müssen sie die Konfiguration vervollständigen. Dazu setzen Sie entweder die Umgebungsvariablen oder erstellen eine Datei application-default.properties. Stellen Sie sicher, dass in der PostgreSQL-Datenbank, die Datenbanken mit den Namen "ige" und "keycloak" angelegt worden sind. Für die weitere Konfiguration, siehe Umgebungsvariablen. Danach:

Damit das Frontend verfügbar ist, muss dieses noch auf den Klassenpfad der Anwendung gesetzt werden. Dazu muss das Startskript unter "bin/ingrid-editor" angepasst werden:

# replace
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $INGRID_EDITOR_OPTS -jar "\"$JARPATH\"" "$APP_ARGS"
# with
JAVA_OPTS="-Dloader.path=/opt/ingrid/ingrid-editor/webapp/"
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $INGRID_EDITOR_OPTS -cp "\"$JARPATH\"" org.springframework.boot.loader.launch.PropertiesLauncher "$APP_ARGS"

Danach können Sie den Editor im Verzeichnis /opt/ingrid/ingrid-editor wie folgt starten:

bin/ingrid-editor

Konfiguration¶

Umgebungsvariablen¶

Die folgenden Umgebungsvariablen können direkt über die docker-compose.yml gesetzt werden, um den InGrid Editor zu konfigurieren.

FAQ¶

RewriteCond %{HTTP:Connection} Upgrade [NC]
RewriteCond %{HTTP:Upgrade} websocket [NC]
RewriteRule /(.*) ws://localhost:18101/$1 [P,L]