Step 6: Final steps

Installing fonts

You need to install 2 types of fonts for screenshot generation:

• In order to generate screenshots with textual elements, there must be a TrueType font like Arial (or one of the metric compatible fonts: Liberation Sans or Arimo) installed on the system.

• To be able to generate screenshots of boards containing emojis, there must be an emoji-compatible font installed on the system (like OpenSansEmoji, Symbola or EmojiSymbols).

Installing fonts on Windows

For text elements, Arial font is provided by default with Windows. You can skip this step if you are using Windows as a server and you are not planning to use Japanese. If you consider using Japanese, its language pack must be installed on your Windows server.

For Emojis, you need to:

1. download a compatible font like OpenSansEmoji from here for example.

2. drag and drop this file in your Windows Fonts directory.

Installing fonts on Linux

For a non-European character set, you need to have a compatible font installed.

The installation process depends on your system. You need to restart your application server after installing fonts.

For a European character set:

• For Linux distributions supporting yum:

yum install liberation-*

• For other distributions:

  1. Download the font available here (Take the TrueType (ttf) binary).

  2. Extract the content to the folder: /usr/share/fonts.

  3. Use the following command to let the server integrate the new font:

     fc-cache -f -v

For other character sets, you can use these commands on compatible systems:

• Japanese:

  yum groupinstall "Japanese Support"

• Chinese:

  yum groupinstall "Chinese Support"

• Korean:

  yum groupinstall "Korean Support"

• Kannada:

  yum groupinstall "Kannada Support"

• Hindi:

  yum groupinstall "Hindi Support"

For Emojis:

1. Download the font available here.

2. Add the font in the folder: /usr/share/fonts

3. Use the following command to let the server integrate the new font:

   fc-cache -f -v

Configuring Tomcat memory and Classpath settings

Java applications like iObeya run in a “Java Virtual Machine” (JVM), instead of running directly within an operating system.

When started, the Java Virtual Machine is allocated a certain amount of memory available to applications it hosts. By default, Java Virtual Machines are allocated 64Mb of memory, no matter how many gigabytes of memory the server may actually have available. This amount is inadequate for standard iObeya installations so it needs to be increased.

Increase server memory allocation on Windows

There are two ways to configure system properties if Tomcat is started as a service.

Setting properties for Windows services via command line

To set properties for Windows services via command line:

1. Go into the /bin directory of the Tomcat installation.

2. Execute Tomcat9w.exe.

3. Set the maximum memory allocation to 4827m or more, depending on the memory you want to allocate.

   Tip:

   We recommend to set a value inferior or equal to 55% of the total memory allocated to the server or virtual machine.

4. Click on the Java tab to see the list of current start-up options.

5. Add to the java options section the following parameters:

   -XX:MaxMetaspaceSize=512m

   Tip:

   We recommend to set a value inferior or equal to 15% of the total memory allocated to Tomcat.

   -XX:+UseParallelGC

6. Add to the Java 9 options section the following parameters:

   --add-opens=java.base/java.io=ALL-UNNAMED
   --add-opens=java.base/java.lang=ALL-UNNAMED
   --add-opens=java.base/java.lang.reflect=ALL-UNNAMED
   --add-opens=java.base/java.net=ALL-UNNAMED
   --add-opens=java.base/java.security=ALL-UNNAMED
   --add-opens=java.base/java.text=ALL-UNNAMED
   --add-opens=java.base/java.time=ALL-UNNAMED
   --add-opens=java.base/java.util=ALL-UNNAMED
   --add-opens=java.base/java.util.concurrent=ALL-UNNAMED
   --add-opens=java.base/java.util.concurrent.locks=ALL-UNNAMED
   --add-opens=java.base/jdk.internal.misc=ALL-UNNAMED
   --add-opens=java.desktop/com.sun.imageio.plugins.png=ALL-UNNAMED
   --add-opens=java.desktop/java.awt.font=ALL-UNNAMED
   --add-opens=java.management/com.sun.jmx.mbeanserver=ALL-UNNAMED
   --add-opens=java.rmi/sun.rmi.transport=ALL-UNNAMED

Setting properties Windows services via the Windows registry

In some versions of Windows there is no option to add Java variables to the service. In these cases, the properties must be added in the option list in the registry.

To set properties for Windows services via the Windows registry:

1. Launch the registry editor (Start >> Run >> regedit32.exe).

2. Find the Services entry:

   1. 32-bit: HKEY_LOCAL_MACHINE >> SOFTWARE >> Apache Software Foundation >> Procrun 2.0 >> <TOMCAT SERVICE NAME >> Parameters >> Java

   2. 64-bit: HKEY_LOCAL_MACHINE >> SOFTWARE >> Wow6432Node >> Apache Software Foundation >> Procrun 2.0 >> <TOMCAT SERVICE NAME >> Parameters >> Java

3. To change existing properties, especially increasing Xms or Xmx memory, double-click on the appropriate value (respectively JvmMs or JvmMx) and set it to 4827m or more, depending on the memory you want to allocate. Create a new REG_DWORD property if any of the JvmMs or JvmMx do not exist.

   Tip:

   We recommend to set a value inferior or equal to 55% of the total memory allocated to the server or virtual machine.

4. To add additional properties like MaxMetaspaceSize, double-click on Options and add a new line with the following values. There is a maximum of one parameter per line. If the option does not exist, create it as a “Multiple String” value.

   -XX:MaxMetaspaceSize=512m

     It could be 512m or more.

   Note:

   We recommend to set a value inferior or equal to 15% of the total memory allocated to Tomcat.

   -XX:+UseParallelGC

5. To add additional classpath settings, doube click on Options and add a new line with the following values:

   --add-opens=java.base/java.io=ALL-UNNAMED
   --add-opens=java.base/java.lang=ALL-UNNAMED
   --add-opens=java.base/java.lang.reflect=ALL-UNNAMED
   --add-opens=java.base/java.net=ALL-UNNAMED
   --add-opens=java.base/java.security=ALL-UNNAMED
   --add-opens=java.base/java.text=ALL-UNNAMED
   --add-opens=java.base/java.time=ALL-UNNAMED
   --add-opens=java.base/java.util=ALL-UNNAMED
   --add-opens=java.base/java.util.concurrent=ALL-UNNAMED
   --add-opens=java.base/java.util.concurrent.locks=ALL-UNNAMED
   --add-opens=java.base/jdk.internal.misc=ALL-UNNAMED
   --add-opens=java.desktop/com.sun.imageio.plugins.png=ALL-UNNAMED
   --add-opens=java.desktop/java.awt.font=ALL-UNNAMED
   --add-opens=java.management/com.sun.jmx.mbeanserver=ALL-UNNAMED
   --add-opens=java.rmi/sun.rmi.transport=ALL-UNNAMED

   Note:

   There is a maximum of parameter per line.    

Increase server memory on Linux

Configure Tomcat memory in Linux installations

To configure Tomcat memory in linux installations:

1. From path_to_tomcat_directory/bin, open setenv.sh.

2. Find the CATALINA_OPTS section and set the following values:

   -Xms512m -Xmx4827m -Xmn512m -XX:MaxMetaspaceSize=512m -XX:+UseParallelGC --add-opens=java.base/java.io=ALL-UNNAMED --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.lang.reflect=ALL-UNNAMED --add-opens=java.base/java.net=ALL-UNNAMED --add-opens=java.base/java.security=ALL-UNNAMED --add-opens=java.base/java.text=ALL-UNNAMED --add-opens=java.base/java.time=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.base/java.util.concurrent=ALL-UNNAMED --add-opens=java.base/java.util.concurrent.locks=ALL-UNNAMED --add-opens=java.base/jdk.internal.misc=ALL-UNNAMED --add-opens=java.desktop/com.sun.imageio.plugins.png=ALL-UNNAMED --add-opens=java.desktop/java.awt.font=ALL-UNNAMED --add-opens=java.management/com.sun.jmx.mbeanserver=ALL-UNNAMED --add-opens=java.rmi/sun.rmi.transport=ALL-UNNAMED

     You can set higher values depending on the memory you want to allocate.

Tip:

However, we recommend for Xms, Xmn and MaxMetaspaceSize parameters to set a value inferior or equal to 15% of the total memory allocated to Tomcat. For Xmx parameter, the value should be inferior or equal to 55% of the total memory.

Install and use jemalloc to optimize memory allocation on a Linux environment (or Unix-based environment)

You need to install and use jemalloc 3.3.1 to enhance stability on a Linux environment (or Unix-based environment).

jemalloc is a memory allocator library designed to be a more efficient and scalable alternative to the standard memory allocators available in many operating systems. It is optimized for high memory allocation performance and fewer memory leaks. For more general information about jemalloc, refer to the jemalloc documentation available here.

To install jemalloc 3.3.1, follow these steps:

1. The installation method may vary depending on your Operating System:

   1. Either via the package manager (e.g yum, apt, etc.).

      Example for RHEL:

      sudo yum install jemalloc

   2. Or, manually by refering to the jemalloc project documentation available here.

2. Configure Tomcat to load the library:

   1. From path_to_tomcat_directory/bin, open setenv.sh.

   2. Add to the file the following export:

      export LD_PRELOAD=/usr/lib64/libjemalloc.so.1

      Warning:

      The jemalloc lib file path may be different from one Operating System to another.

3. After starting Tomcat in the next step, check that the library is loaded correctly:

   1. Run the following command:

      sudo grep malloc /proc/$(pgrep jsvc -u tomcat)/maps

   2. The result is supposed to display the path of the jemalloc lib on your Operating System.

      Example:

      7f074934d000-7f074937d000 r-xp 00000000 103:03 410868 /usr/lib64/libjemalloc.so.1
      
      7f074937d000-7f074957c000 ---p 00030000 103:03 410868 /usr/lib64/libjemalloc.so.1
      
      7f074957c000-7f074957e000 rw-p 0002f000 103:03 410868 /usr/lib64/libjemalloc.so.1

Starting Tomcat

Warning:

This action can take a long time. Check the progress by watching the log files and see if you have any error.

Start Tomcat to start the web application.

Setting the iObeya licence

Warning:

You need to access the administration interface of your iObeya platform to finalize the installation by providing the license key.

Enter your iObeya server URL in your browser address bar and add “/admin”.

Example: http://<server>:<port>/admin:

• <server>: Hostname or IP address of the Tomcat server,

• <port>: Tomcat port for communication (Tomcat default port: 8080).

By default, a Administrateur de plateforme is created: admin (password: admin)

1. The platform administrator is automatically redirected to the license page.

2. Note the Server ID and send it by email to our Support team explaining if this is for your production instance or a preproduction instance. You rapidly receive your private license key.

3. Open the license file received from our Support team in a text editor and select all the text.

4. Copy and paste the license key text from the text editor into the license text zone in the administration interface of your iObeya platform.

5. Click Save.

   The license is immediately active.

Accessing the application

Type the server URL into the address bar of a web browser to access the homepage of iObeya.

Example: http://<server>:<port>/:

• <server>: Hostname or IP address of the Tomcat server,

• <port>: Tomcat port for communication (Tomcat default port: 8080).