Skip to content

IES Webnode#

The IES webnode is a server application that is installed on all web servers that deliver websites managed by the IES. The IES webnode serves as the "long arm" of the IES and represents the interface between the IES and the web servers. The IES webnode is used, for example, to deploy the web applications that are required to operate the websites.

Start and stop#

The IES webnode is started and stopped via the systemd service manager. The service is called ies-webnode.

Start the IES webnode:

sudo systemctl start ies-webnode

Stop the IES webnode:

sudo systemctl stop ies-webnode

Update#

The update file for the IES-Webnode is transferred via the IES on the web server when an update is initiated from the IES.

The update must then be installed manually on the web server. To do this, the update script is executed on the web server.

sudo systemctl stop ies-webnode
sudo ies-webnode update
sudo systemctl start ies-webnode

Resource change notification#

The IES notifies the websites of a webnode about published and depublished resources, so that their indices are updated. How is configured per webnode in the IES administration:

Setting Meaning
Direct changes are collected for about 10 seconds and sent as one notification
Interval changes are held back for the configured number of minutes
Disabled the website is not notified

Interval is meant for web servers that receive the published files by a rsync: at the moment of publishing, the file is not yet on the web server, so the website would index the old version. Choose a delay that covers the rsync.

A website that does not know the notification yet is left to the solr module, which updates its Solr index through GraphQL as before. The IES detects this by itself.

Warning

Up to now the delay for rsync setups is configured in the solr index configuration (adHocSynchronizationInterval). Take the value over to the webnode before the website is updated to a version that accepts the notification - otherwise the changes are sent too early.

Logs#

The IES-Webnode logs are stored in the directory /var/log/sitepark/ies-webnode/.

JWT Keys#

The IES webnode provides a private and a public key with which the PHP applications can sign and verify JWTs. The keys are stored outside the web applications and are therefore retained even when the applications are updated.

The keys are stored in the file /srv/sitepark/ies-webnode/config/jwt.

Realm-Properties-File#

The realm.properties file is used for simple user administration. A user api with a randomly generated password is stored there during installation. The IES authenticates itself to the IES Webnode via this user.

The file is stored in the directory /srv/sitepark/ies-webnode/config/.

Format of the file#

The realm.properties file consists of key-value pairs, each of which defines a user and their associated properties. The file uses the simple text format and typically looks like this:

# Comments start with a #
# Custom entries consist of username, password and roles

# Username: user
# Password: password
# Roles: role1, role2
user=password,role1,role2

# Example:
api=password,api
admin=password,api,admin
user1=password,user

Explanation of the individual parts

  1. Comments: Lines beginning with a # are comments and are ignored by the system.
  2. User-defined entries: Each entry in the file defines a user. The user name precedes the =. The = is followed by the password and the roles, separated by commas.