Comparaison des versions

Ancienne version 39

changes.mady.by.user Sophie Lepissier

Sauvegardée le

comparé à

Nouvelle version Actuel

changes.mady.by.user Sophie Lepissier

Sauvegardée le

Légende

  • Ces lignes ont été ajoutées. Ce mot a été ajouté.
  • Ces lignes ont été supprimées. Ce mot a été supprimé.
  • La mise en forme a été modifiée.

...

Sv translation
languageen
Remarque

This page is no longer being updated. From BlueMind 4.8, please refer to the new BlueMind documentation

Introduction

By default, BlueMind lets you customize the homepage logo.

To replace the default homepage by a customized page, you have to write an HPS extension.

Avertissement

The procedure shown here is just an example.

After an update, you may have to adapt it to the new BlueMind version.

If this extension is present in your installation, we strongly recommend that you test its behavior on a pre-production platform using the version of BlueMind you are planning to use in production.

Prerequisites

A test installation of BlueMind in the latest available version.

Principle

To edit the BlueMind homepage and replace it by your own custom version, you have to write an HPS extension that will overload the official homepage's template and resources.

Initialising the extension

Naming the extension

You have to give your extension a name. This name can use the [a-z] characters and "." (period).

Remarque

In this document, we've chosen to name the extension my.sample.loginpage, make sure you replace it by the name you have chosen for your extension.

Creating a structure for the extension

Connect as the root user on the BlueMind test installation, then:

  1. Run the following commands:

    Bloc de code
    languagebash
    mkdir /root/my.sample.loginpage
cd /root/my.sample.loginpage
mkdir META-INF templates web-resources

  2. Create a file named /root/my.sample.loginpage/META-INF/MANIFEST.MF, with the following content: 

    Bloc de code
    Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: my.sample.loginpage
Bundle-SymbolicName: my.sample.loginpage
Bundle-Version: 1.0.0
Bundle-Vendor: bluemind.net
Fragment-Host: net.bluemind.webmodules.loginapp
Bundle-RequiredExecutionEnvironment: JavaSE-1.8
    Remarque

    Remember to adapt the Bundle-Name and Bundle-SymbolicName lines according to the name you have chosen for your extension.

Defining your homepage

The homepage essentially contains two types of data:

  • the page's HTML code in a template
  • the page's resources (images, CSS...).

HTML

The page's HTML code has to be put into the file named templates/login.xml. BlueMind will analyze this template file and dynamically populate it with data.

The <body> section of the template has to contain the authentication form's original code – the latest version of this code can be found on the login.xml page of our git repository. Copy the following code sections:

  1. From <#if authErrorMsg??> to </#if> (tags included)
  2. The actual form's part of the code: from <form> to </form> (tags included)

In addition, the template's </body> tag has to be preceded by:

Bloc de code
${jsRuntime}

Resources

Homepage resources -- images, CSS sheets... -- have to be placed into the web-resources page.

You can reference the resources from this repository into the HTML code. E.g. to insert the web-resources/sample.jpg resource from the templates/login.xml template:

Bloc de code
<img src="sample.jpg>Sample image</img>
Astuce

If you create a folder structure, use the relative notation to reference the folders, always with web-resources as the root folder. E.g. for a CSS sheet  in/web-ressources/css/style.css:

Bloc de code
<link rel="stylesheet" href="css/style.css" />

Note: the folder structure doesn't start with '/', which would point to the website's root. 

You can find default resources in our git repository: https://forge.bluemind.net/stash/projects/BM/repos/bluemind-public/browse/ui/webmodules/net.bluemind.webmodules.loginapp/web-resources

Building and installing the extension
Ancre
buildAndInstall
buildAndInstall

Log in as root on the BlueMind test installation, then:

  1. Build the extension

    Bloc de code
    cd /root/my.sample.loginpage
/usr/lib/jvm/bm-jdk/bin/jar cvfm /root/my.sample.loginpage_1.0.0.jar META-INF/MANIFEST.MF .

  2. Install the extension:

    Bloc de code
    cd /usr/share/bm-hps/extensions
mkdir my.sample.loginpage
mv /root/my.sample.loginpage_1.0.0.jar my.sample.loginpage/

  3. Restart the HPS service:

    Bloc de code
    /etc/init.d/bm-hps stop
rm -rf /var/lib/bm-hps
/etc/init.d/bm-hps start


Then log into BlueMind, your custom homepage should be displayed instead of the standard BlueMind homepage.

Avertissement

If your homepage isn't displayed, force-refresh your browser by holding the shift key while reloading the page.

Using your web browser in private mode also helps prevent possible cache issues.

Notes

Example

The code for the my.sample.loginpage plugin described in this documentation is available at: https://github.com/bluemind-net/loginapp-plugin-sample/tree/master/my.sample.loginpage.

To test it:

  1. Download the extension here: https://github.com/bluemind-net/loginapp-plugin-sample/raw/master/build/my.sample.loginpage_1.0.0.jar
  2. Refer to steps 2 and 3 of the Building and installing the extension paragraph.
Info

The contents of the extension can be edited using software that supports the zip compression format (e.g. winzip).

You can replace the templates/login.xml template file, and add or delete resources in the web-resources folder.

Sv translation
languagede
Remarque

Diese Seite ist nicht mehr aktuell. Ab der Version BlueMind 4.8 finden Sie alle Infos in der neuen Dokumentation

Präsentation

Standardmäßig kann mit BlueMind das Logo der Startseite angepasst werden.

Um die Standard-Startseite durch eine benutzerdefinierte Seite zu ersetzen, muss eine Erweiterung für den HPS-Dienst geschrieben werden.

Avertissement

Diese Methode wird als Beispiel angegeben.

Bei Updates muss die Erweiterung eventuell an die neue Version von BlueMind angepasst werden.

Wenn eine solche Erweiterung in Ihrer Installation vorhanden ist, raten wir dringend, ihr Verhalten auf einer Vorproduktionsplattform mit der Version von BlueMind zu testen, die Sie in Produktion nehmen möchten.

Voraussetzungen

Eine Testinstallation von BlueMind wurde auf die neueste verfügbare Version aktualisiert.

Prinzip

Die Modifikation der BlueMind-Startseite erfolgt durch das Schreiben einer HPS-Erweiterung, die die offizielle Startseiten-Vorlage und die Ressourcen außer Kraft setzt, um eine eigene Startseite zu definieren.

Initialisieren der Erweiterung

Definition des Erweiterungsnamens

Sie müssen einen Namen für Ihre Erweiterung festlegen. Dieser Name kann aus den Zeichen [a-z] und . (Punkt) bestehen. (Punkt).

Remarque

Im Rest dieser Dokumentation haben wir den Namen my.sample.loginpage gewählt. Vergessen Sie nicht, ihn durch den für Ihre Erweiterung gewählten Namen zu ersetzen.

Erstellen der Erweiterungsstruktur

Melden Sie sich als Root-Benutzer auf der BlueMind-Testinstallation an und:

  1. führen Sie die folgenden Befehle aus:

    Bloc de code
    languagebash
    mkdir /root/my.sample.loginpage
cd /root/my.sample.loginpage
mkdir META-INF templates web-resources

  2. Erstellen Sie die Datei /root/my.sample.loginpage/META-INF/MANIFEST.MF mit dem Inhalt:

    Bloc de code
    Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: my.sample.loginpage
Bundle-SymbolicName: my.sample.loginpage
Bundle-Version: 1.0.0
Bundle-Vendor: bluemind.net
Fragment-Host: net.bluemind.webmodules.loginapp
Bundle-RequiredExecutionEnvironment: JavaSE-1.8
    Remarque

    Denken Sie daran, die Zeilen Bundle-Name und Bundle-SymbolicName entsprechend dem für Ihre Erweiterung gewählten Namen anzupassen

Definieren Sie Ihre Startseite

Die Startseite besteht im Wesentlichen aus 2 Datentypen:

  • HTML-Code Seite in Form einer Vorlage
  • Den von Ihrer Seite referenzierten Ressourcen (Bilder, CSS...)

HTML

Der HTML-Code der Seite muss in der Datei templates/login.xml platziert werden. Diese Modelldatei wird von BlueMind analysiert und die Daten werden dynamisch in die Datei eingefügt.

Diese Vorlage muss im Abschnitt <body> den Code des ursprünglichen Authentifizierungsformulars enthalten. Um die neueste Version dieses Codes zu erhalten, gehen Sie zur Seite login.xml in unserem Git-Repository und kopieren Sie die folgenden Abschnitte:

  1. den Abschnitt von <#if authErrorMsg??> bis </#if> (inklusive Tags)
  2. den Abschnitt des eigentlichen Formulars: von <form> bis </form> (inklusive Tags)

Darüber hinaus muss dem Tag </body> des Modells Folgendes vorangestellt werden:

Bloc de code
${jsRuntime}

Ressourcen

Die Ressourcen Ihrer Startseite, z.B. wie Bilder, CSS-Sheets... - müssen im Ordner web-resources abgelegt werden.

Sie können im HTML-Code direkt auf Ressourcen aus diesem Verzeichnis verweisen. Zum Beispiel, um die Ressource web-resources/sample.jpg aus der Vorlage templates/login.xml einzufügen:

Bloc de code
<img src="sample.jpg>Sample image</img>
Astuce

Wenn Sie einen Ordnerbaum erstellen, verwenden Sie die relative Notation, um auf sie zu verweisen, wobei Web-Ressourcen immer als Stammverzeichnis betrachtet werden. Zum Beispiel für ein CSS-Sheet, das in /web-resources/css/style.css abgelegt ist:

Bloc de code
<link rel="stylesheet" href="css/style.css" />

NB: Beachten Sie, dass die Baumstruktur nicht mit '/' beginnt, was auf das Stammverzeichnis der Website verweisen würde

Sie finden die Standard-Ressourcen in unserem Git-Repository: https://forge.bluemind.net/stash/projects/BM/repos/bluemind-public/browse/ui/webmodules/net.bluemind.webmodules.loginapp/web-resources

Generieren und installieren Sie die Erweiterung
Ancre
buildAndInstall
buildAndInstall

Melden Sie sich als Root-Benutzer auf der BlueMind-Testinstallation an und:

  1. die Erweiterung generieren:

    Bloc de code
    cd /root/my.sample.loginpage
/usr/lib/jvm/bm-jdk/bin/jar cvfm /root/my.sample.loginpage_1.0.0.jar META-INF/MANIFEST.MF .

  2. die Erweiterung installieren:

    Bloc de code
    cd /usr/share/bm-hps/extensions
mkdir my.sample.loginpage
mv /root/my.sample.loginpage_1.0.0.jar my.sample.loginpage/

  3. den HPS-Dienst neu starten:

    Bloc de code
    /etc/init.d/bm-hps stop
rm -rf /var/lib/bm-hps
/etc/init.d/bm-hps start

Nach der Anmeldung in BlueMind muss anstelle der Standard-BlueMind-Seite Ihre Seite angezeigt werden.

Avertissement

Wird die Seite nicht angezeigt, erzwingen Sie eine Aktualisierung, indem Sie die Shift-Taste gedrückt halten, während Sie die Seite neu laden.

Sie können einen Browser im privaten Browsing-Modus verwenden, um mögliche Cache-Effekte zu vermeiden.

Hinweise

Beispiel

Der Code des in dieser Dokumentation beschriebenen my.sample.loginpage-Plugins ist auf dieser Seite verfügbar: https://github.com/bluemind-net/loginapp-plugin-sample/tree/master/my.sample.loginpage

Um sie zu testen:

  1. laden Sie die generierte Erweiterung über dieses Link herunter: https://github.com/bluemind-net/loginapp-plugin-sample/raw/master/build/my.sample.loginpage_1.0.0.jar
  2. beachten Sie die Schritte 2 und 3 des Abschnitts Erweiterung generieren und installieren
Info

Der Inhalt der generierten Erweiterung kann direkt von einer Software aus geändert werden, die das Zip-Komprimierungsformat unterstützt (z.B. Winzip).

Sie können die Vorlagendatei templates/login.xml ersetzen und Ressourcen im Ordner web-resources hinzufügen oder entfernen.