Skip to main content

Installation

With the free Hanami SKOS Edition, available as a docker container, you will be able to create skos:ConceptScheme graphs and adapt their format to suit your needs.

The Hanami SKOS Edition is designed to provide users with a range of functionalities that can be adapted to meet their specific needs. Thanks to the free docker container, users can easily create skos:ConceptScheme graphs and customize their format according to their preferences.

In addition, the user-friendly interface allows for intuitive navigation and easy management of large datasets. The Hanami SKOS Edition also offers a range of advanced features for data quality management.

This guide provides step-by-step instructions on how to download and install the Hanami SKOS Edition. Please follow the provided steps carefully to ensure a successful installation.

Requirements

Before proceeding with the installation, make sure you have the following software installed and your server meets the following requirements:

Software to install​

→ Docker is up and running.

In case you are using Docker Desktop, make sure that you start it if it's not running already

# Use the following command on a terminal window to check if it's installed and its version
docker --version

# Use the following command to see if the docker engine is up and running
docker ps

→ Docker Compose binary is available on the host.

# Check the installation with
docker-compose --version

Download the edition

Visit the Hanami SKOS Edition page to download the latest version of the edition. You have to fill out the form to access the free download.

Server requirements​

The user who will perform the installation needs to have all necessary privileges to use Docker, Docker Compose and the filesystem-related permissions.

Specifications for the host machine that will serve Hanami:

Minimum

  • 8 GB RAM
  • 4 Core CPU

Recommended (Default)

  • 16 GB RAM
  • 4-8 Core CPU

Installation Process

Linux Installation​

  1. Set the vm.max_map_count with root privileges in order for Elasticsearch to operate

    sudo sysctl -w vm.max_map_count=262144

  2. Extract the downloaded hanami-skos-edition.zip file archive and choose the installation directory using the GUI or following these terminal commands:

    # Create a new directory
    mkdir /path/to/extract/files/to

    # Extract the archive to the directory created above
    unzip hanami-skos-edition.zip -d /path/to/extract/files/to

  3. Open a terminal window (if not done yet) and navigate to the directory where the archive was extracted.

    cd /path/to/extract/files/to

    Note: Additional modification needed if running with minimum resources

  4. Execute the start script

    ./start-hanami.sh

  5. Once you see that the application is started you can open your browser and navigate to http://localhost:8080.

  6. Credentials to log in are:

    • Username: admin
    • Password: admin

Tested on:

  • Ubuntu 22.04 with BASH shell

Windows Installation​

  1. Extract the downloaded hanami-skos-edition.zip file archive and choose the installation directory using the GUI or following these terminal commands:

    # Create a new directory
    mkdir 'C:\path\to\extract\files\to'

    # Extract the archive to the new directory
    tar.exe -xf 'C:\path\to\hanami-skos-edition.zip' -C 'C:\path\to\extract\files\to'

  2. Open a terminal window (if not done yet) and navigate to the directory where the archive was extracted.

    cd 'C:\path\to\extracted\directory'

    Additional modification needed if running with minimum resources

  3. Execute the start script

    .\start-hanami.bat

  4. Once you see that the application is started you can open your browser and navigate to http://localhost:8080.

  5. Credentials to log in are:

    • Username: admin
    • Password: admin

Tested on:

  • Windows 10 with Powershell and cmd

Mac Installation​

  1. Set the vm.max_map_count with root privileges in order for Elasticsearch to operate

    sudo sysctl -w vm.max_map_count=262144

  2. Extract the downloaded hanami-skos-edition.zip file archive and choose the installation directory using the GUI or following these terminal commands:

    # Create a new directory
    mkdir /path/to/extract/files/to

    # Extract the archive to the directory created above
    unzip hanami-skos-edition.zip -d /path/to/extract/files/to

  3. Open a terminal window (if not done yet) and navigate to the directory where the archive was extracted.

    cd /path/to/extracted/files

    Additional modification needed if running with minimum resources

  4. Execute the start script

    ./start-hanami.sh

  5. Once you see that the application is started you can open your browser and navigate to http://localhost:8080 .

  6. Credentials to log in are:

    • Username: admin
    • Password: admin

Tested on:

  • MacOS Ventura 13.5.2 with zsh shell

How to configure for minimum specs​

This section assumes that you have extracted the archive and your current working directory is where the extracted content is located. No related Docker containers should be running or stopped. If this is the case, run docker compose down while being in the extracted directory.

If your machine has resources that are below our recommendation, you need to try to lower the memory allocated to each process by following these steps:

  1. Edit the file docker-compose.yml in an editor of your choice.
  2. Alter the following lines and adjust the memory allocation:
    • from ES_JAVA_OPTS=-Xms2G -Xmx2G to ES_JAVA_OPTS=-Xms1G -Xmx1G
    • from JAVA_OPTS=-Xms4G -Xmx4G to JAVA_OPTS=-Xms3G -Xmx3G
  3. Continue the installation, relevant to your OS (Linux Windows Mac).

Troubleshooting​

By following these steps, you should have the Hanami SKOS version up and running on your system. If you encounter any issues, please refer to our Help section of this documentation or contact our support team workwith@hanami.app.