{"id":21,"date":"2022-05-05T14:24:27","date_gmt":"2022-05-05T12:24:27","guid":{"rendered":"https:\/\/kairntech.com\/doc\/?page_id=21"},"modified":"2026-01-24T19:10:43","modified_gmt":"2026-01-24T18:10:43","slug":"installation-guide","status":"publish","type":"page","link":"https:\/\/kairntech.com\/doc\/installation-guide\/","title":{"rendered":"Installation Guide"},"content":{"rendered":"\n<h2 class=\"wp-block-heading\" id=\"supported-operating-systems\">Supported Operating Systems<\/h2>\n\n\n\n<p>The Kairntech platform has been successfully validated on the following operating systems, for both <strong>CPU<\/strong> and <strong>GPU<\/strong> deployments:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Ubuntu 20.04.6 LTS (x64), or higher<\/strong><\/li>\n\n\n\n<li><strong>RHEL \/ CentOS7 (x64), or higher<\/strong><\/li>\n<\/ul>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\">\n<p><strong>Note<\/strong>: When deploying in a <strong>CPU-only<\/strong> environment, Docker-based virtualization removes most OS-level constraints. However, for <strong>GPU-based<\/strong> deployment, compatibility is restricted due to <strong>NVIDIA driver requirements<\/strong>. Only the above-listed OS versions are officially supported for GPU setups.<\/p>\n<\/blockquote>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"installation-steps\">Installation steps<\/h2>\n\n\n\n<p>All listed commands below come from the environment <strong>UBUNTU 18.04 LTS x64<\/strong>.<\/p>\n\n\n\n<p>Host configuration prerequisites:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><a href=\"#host-configuration-prerequisites\" data-type=\"internal\">Host configuration prerequisites<\/a><\/li>\n\n\n\n<li><a href=\"#user-folders-creation\">User\/folders creation<\/a><\/li>\n\n\n\n<li><a href=\"#binaries-installation\" data-type=\"internal\">Binaries installation<\/a><\/li>\n<\/ul>\n\n\n\n<p>Kairntech platform Docker volumes prerequisites<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><a href=\"#docker-volumes-to-mount\" data-type=\"internal\" data-id=\"#Kairntech-platform-installation-prerequisites:-Flair-embeddings\">Docker volumes to mount<\/a><\/li>\n<\/ul>\n\n\n\n<p>Kairntech platform installation<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><a href=\"#kairntech-platform-installation\" data-type=\"internal\"><strong>Kairntech platform installation<\/strong><\/a><\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"host-configuration-prerequisites\">Host configuration prerequisites: <\/h2>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"host-configuration-prerequisites:-elasticsearch\">ELASTICSEARCH recommendation<\/h3>\n\n\n\n<p>You may need to increase the <code>vm.max_map_count<\/code> kernel parameter to avoid running out of map areas.<\/p>\n\n\n\n<p>In order to avoid such message:<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>&#91;1]: max virtual memory areas vm.max_map_count &#91;65530] is too low, increase to at least &#91;262144]<\/code><\/pre>\n\n\n\n<p>It is recommended to edit file <code>\/etc\/sysctl.conf<\/code> and insert the following lines:<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code># ES - at least 262144 for production use\nvm.max_map_count=262144<\/code><\/pre>\n\n\n\n<p>Apply the modification with using the following command<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>sudo sysctl -p<\/code><\/pre>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"host-configuration-prerequisites:-inotify\">INOTIFY recommendation<\/h3>\n\n\n\n<p>You may need to increase the <code>fs.inotify.max_user_instances<\/code> parameter to avoid reaching user limits on the number of inotify resources.<\/p>\n\n\n\n<p>In order to avoid such message<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>&#91;Errno 24] inotify instance limit reached<\/code><\/pre>\n\n\n\n<p>It is recommended to edit file <code>\/etc\/sysctl.conf<\/code> and insert the following lines:<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code># Prevent &#91;Errno 24] inotify instance limit reached\nfs.inotify.max_user_instances = 65530<\/code><\/pre>\n\n\n\n<p>Apply the modification with using the following command<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>sudo sysctl -p<\/code><\/pre>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"host-configuration-prerequisites:-haproxy\">HAPROXY recommendation (kernel \u2265 4.11)<\/h3>\n\n\n\n<p>You may need to set <code>net.ipv4.ip_unprivileged_port_start<\/code> to let to non root user <em>haproxy<\/em> the permission to run on priviledged port 443.<\/p>\n\n\n\n<p>In order to avoid such message (in haproxy container console output)<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>&#91;ALERT]    (1) : Starting frontend http-in-sherpa: cannot bind socket (Permission denied) &#91;0.0.0.0:443]\n&#91;ALERT]    (1) : &#91;haproxy.main()] Some protocols failed to start their listeners! Exiting.<\/code><\/pre>\n\n\n\n<p>It is recommended to edit file <code>\/etc\/sysctl.conf<\/code> and insert the following lines:<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code># Enable haproxy to listen to 443\nnet.ipv4.ip_unprivileged_port_start=0<\/code><\/pre>\n\n\n\n<p>Apply the modification with using the following command<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>sudo sysctl -p<\/code><\/pre>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"user-folders-creation\">User\/Folder creation<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"user-folders-creation-prerequisites:-user-creation\">USER creation<\/h3>\n\n\n\n<p>Is it <strong>highly advised<\/strong> to create a specific user, for the deployment of the platform:<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code># FOR A STANDARD USER\nsudo adduser kairntech\n\n# OR FOR A HEADLESS USER\nsudo adduser --disabled-password --gecos \"\" kairntech<\/code><\/pre>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"user-folders-creation-prerequisites:-folders-creation\">FOLDER creation<\/h3>\n\n\n\n<p>Is it <strong>highly advised<\/strong> to create a specific folder, for the deployment of the platform:<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>sudo mkdir -p \/opt\/sherpa\nsudo chown -R kairntech. \/opt\/sherpa<\/code><\/pre>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\">\n<p>Directory <code><strong>\/opt\/sherpa\/<\/strong><\/code> will store all files and folders relative to the platform (<strong>delivered by Kairntech<\/strong>)<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>File <code>docker-compose.yml<\/code> will be used to deploy\/pull Docker images of the platform<\/li>\n\n\n\n<li>Folder <code>init<\/code> will be used to deploy prerequisites docker volumes content<\/li>\n<\/ul>\n<\/blockquote>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"binaries-installation\">Binaries installation<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"binaries-installation:-docker-installation\">Docker \/ Docker Compose installation<\/h3>\n\n\n\n<p>The platform being based on a Docker-type solution, please install docker and docker compose plugin.<br>The official page indicating the installation commands is located <a href=\"https:\/\/docs.docker.com\/engine\/install\/ubuntu\/.\" data-type=\"URL\" data-id=\"https:\/\/docs.docker.com\/engine\/install\/ubuntu\/.\">here<\/a>. <\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>sudo apt-get update\nsudo apt-get install ca-certificates curl gnupg\n\nsudo install -m 0755 -d \/etc\/apt\/keyrings\ncurl -fsSL https:\/\/download.docker.com\/linux\/ubuntu\/gpg | sudo gpg --dearmor -o \/etc\/apt\/keyrings\/docker.gpg\nsudo chmod a+r \/etc\/apt\/keyrings\/docker.gpg\n\necho \"deb &#91;arch=\"$(dpkg --print-architecture)\" signed-by=\/etc\/apt\/keyrings\/docker.gpg] https:\/\/download.docker.com\/linux\/ubuntu \"$(. \/etc\/os-release &amp;&amp; echo \"$VERSION_CODENAME\")\" stable\" | sudo tee \/etc\/apt\/sources.list.d\/docker.list &gt; \/dev\/null\n\nsudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin<\/code><\/pre>\n\n\n\n<p>Then you will have to add the kairntech user to the docker group<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>sudo usermod -aG docker kairntech<\/code><\/pre>\n\n\n\n<p><em>As mentionned in the installation guide, log out and log back in so that your group membership is re-evaluated.<\/em><\/p>\n\n\n\n<p>If you want to test, <strong>open a new session terminal<\/strong> and run<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>sudo su - kairntech\n\ndocker run hello-world<\/code><\/pre>\n\n\n\n<p>After installing the compose plugin, you can test via:<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>sudo su - kairntech\n\ndocker compose version<\/code><\/pre>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"docker-volumes-to-mount\">Docker volumes to mount<\/h2>\n\n\n\n<p>The binary <code>docker<\/code> will be used to feed docker volumes with embeddings files; to select specific languages, or all languages, an <code>.env<\/code> file is used for indicating the choice.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"docker-volumes-to-mount:-flair\">FLAIR embeddings<\/h3>\n\n\n\n<p>The engine Flair require some \u00ab embeddings \u00bb files: these static files are stored as Docker volumes. In order to get these files, please run:<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>sudo su - kairntech\n\ncd \/opt\/sherpa\/init\/flair-init-job\n\n# INSTALL AR, DE, EN AND FR\ncat flair.env \nFLAIR_LANGUAGES=ar,de,en,fr\nFLAIR_RESOURCES_VERSION=default\ndocker compose -f docker-compose.yml up\n\n# OR INSTALL ALL LANGUAGES\ncat flair.env \nFLAIR_LANGUAGES=all\nFLAIR_RESOURCES_VERSION=default\ndocker compose -f docker-compose.yml up<\/code><\/pre>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\">\n<p>The variable <code>FLAIR_LANGUAGES<\/code> can be modified to indicate the language selection.<\/p>\n<\/blockquote>\n\n\n\n<p>The Docker container can be removed, once Flair embeddings are deployed, via:<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>docker rm flair-resources-init-job<\/code><\/pre>\n\n\n\n<div style=\"height:25px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<p class=\"has-text-align-center\">The table below gives disk usage corresponding to available languages:<\/p>\n\n\n\n<figure class=\"wp-block-table is-style-stripes\"><table class=\"has-fixed-layout\"><thead><tr><th class=\"has-text-align-left\" data-align=\"left\">Language<\/th><th>Size<\/th><\/tr><\/thead><tbody><tr><td class=\"has-text-align-left\" data-align=\"left\">Arabic (AR)<\/td><td>2.9G<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">German (DE)<\/td><td>4.3G<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">English (EN)<\/td><td>3.8G<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">Spanish (ES)<\/td><td>4.2G<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">Farsi (FA)<\/td><td>768M<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">French (FR)<\/td><td>4.2G<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">Hindi (HI)<\/td><td>1.0G<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">Italian (IT)<\/td><td>3.9G<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">Dutch (NL)<\/td><td>3.9G<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">Portuguese (PT)<\/td><td>2.7G<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">Russian (RU)<\/td><td>4.1G<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">Chinese (ZH)<\/td><td>1.6G<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">All<\/td><td>35G<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"docker-volumes-to-mount:-fasttext\">FASTTEXT embeddings<\/h3>\n\n\n\n<p>The engine fastText require some \u00ab embeddings \u00bb files: these static files are stored as Docker volumes. In order to get these files, please run:<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>sudo su - kairntech\n\ncd \/opt\/sherpa\/init\/fasttext-init-job\n\n# INSTALL AR, DE, EN AND FR\ncat fasttext.env \nFASTTEXT_LANGUAGES=ar,de,en,fr\nFASTTEXT_RESOURCES_VERSION=default\ndocker compose -f docker-compose.yml up\n\n# OR INSTALL ALL LANGUAGES\ncat fasttext.env \nFASTTEXT_LANGUAGES=all\nFASTTEXT_RESOURCES_VERSION=default\ndocker compose -f docker-compose.yml up<\/code><\/pre>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\">\n<p>The variable <code>FASTTEXT_LANGUAGES<\/code> can be modified to indicate the language selection.<\/p>\n<\/blockquote>\n\n\n\n<p>The Docker container can be removed, once fastText embeddings are deployed, via:<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>docker rm flair-resources-init-job<\/code><\/pre>\n\n\n\n<div style=\"height:25px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<p class=\"has-text-align-center\">The table below gives disk usage corresponding to available languages:<\/p>\n\n\n\n<figure class=\"wp-block-table is-style-stripes\"><table class=\"has-fixed-layout\"><thead><tr><th>Language<\/th><th>Size<\/th><\/tr><\/thead><tbody><tr><td>Arabic (AR)<\/td><td>1.5G<\/td><\/tr><tr><td>German (DE)<\/td><td>5.6G<\/td><\/tr><tr><td>English (EN)<\/td><td>6.2G<\/td><\/tr><tr><td>Spanish (ES)<\/td><td>2.5G<\/td><\/tr><tr><td>French (FR)<\/td><td>2.9G<\/td><\/tr><tr><td>Italian (IT)<\/td><td>2.2G<\/td><\/tr><tr><td>Japanese (JA)<\/td><td>1.3G<\/td><\/tr><tr><td>Portuguese (PT)<\/td><td>1.5G<\/td><\/tr><tr><td>Russian (RU)<\/td><td>4.7G<\/td><\/tr><tr><td>Chinese (ZH)<\/td><td>822M<\/td><\/tr><tr><td>All<\/td><td>29G<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"docker-volumes-to-mount:-entity-fishing\">ENTITY-FISHING knowledge<\/h3>\n\n\n\n<p>The component entity-fishing require some \u00ab knowledge \u00bb files: these static files are generated every month, and stored as Docker volumes. In order to get these files, please run:<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>sudo su - kairntech\n\ncd \/opt\/sherpa\/init\/entity-fishing-init-job\n\n# INSTALL AR, DE, EN AND FR\ncat entity-fishing.env \nENTITY_FISHING_LANGUAGES=ar,de,en,fr\nENTITY_FISHING_RESOURCES_VERSION=2025-07-10\ndocker compose -f docker-compose.yml up\n\n# OR INSTALL ALL LANGUAGES\ncat entity-fishing.env \nENTITY_FISHING_LANGUAGES=all\nENTITY_FISHING_RESOURCES_VERSION=2025-07-10\ndocker compose -f docker-compose.yml up<\/code><\/pre>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\">\n<p>The variable <code>ENTITY_FISHING_RESOURCES_VERSION<\/code> can be modified to match the most recent knwoledge.<\/p>\n<\/blockquote>\n\n\n\n<p>The Docker container can be removed, once entity-fishing knowledge is deployed, via:<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>docker rm entity-fishing-init-job<\/code><\/pre>\n\n\n\n<p class=\"has-text-align-center\">The table below gives disk usage corresponding to available languages:<\/p>\n\n\n\n<figure class=\"wp-block-table is-style-stripes\"><table class=\"has-fixed-layout\"><thead><tr><th class=\"has-text-align-left\" data-align=\"left\">Language<\/th><th>Size<\/th><\/tr><\/thead><tbody><tr><td class=\"has-text-align-left\" data-align=\"left\">Arabic (AR)<\/td><td>36.7G (3.7G + 33G)<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">German (DE)<\/td><td>40.0G (6.0G + 33G)<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">English (EN)<\/td><td>49G (16G + 33G)<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">Spanish (ES)<\/td><td>37.4G (4.4G + 33G)<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">Farsi (FA)<\/td><td>36.5G (3.5G + 33G)<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">French (FR)<\/td><td>38.6G (5.6G + 33G)<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">Italian (IT)<\/td><td>36.9G (3.9G + 33G)<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">Japanese (JA)<\/td><td>36.6G (3.6G + 33G)<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">Portuguese (PT)<\/td><td>35.8G (2.8G + 33G)<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">Russian (RU)<\/td><td>39.4G (6.4G + 33G)<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">Chinese (ZH)<\/td><td>36.1G (3.1G + 33G)<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">Ukrainian (UA)<\/td><td>36.6G (3.6G + 33G)<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">Indian (HI)<\/td><td>33.5G (455M + 33G)<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">Swedish (SE)<\/td><td>37.2G (4.2G + 33G)<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">Bengali (BD)<\/td><td>33.7G (700M + 33G)<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\">All<\/td><td>100G (67G + 33G)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p>In these metrics, the <em>common knowledge<\/em> takes 33G of disk usage, and is mandatory. <\/p>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"docker-volumes-to-mount:-entity-fishing\">VECTORIZERS<\/h3>\n\n\n\n<p>In order to fully utilize the vectorizers, language models files must be downloaded: these static files are stored as Docker volumes. In order to get these files, please run:<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>sudo su - kairntech\n\ncd \/opt\/sherpa\/init\/vectorizers-init-job\/\n\n# INSTALL allMiniLML6V2\ncat vectorizer.env\nVECTORIZER_RESOURCES_VERSION=sentence-transformers\/all-MiniLM-L6-v2\ndocker compose -f docker-compose.allminilml6v2.yml up\ndocker rm vectorizer-resources-init-job\n\n# INSTALL multiMiniLML12V2\ncat vectorizer.env\nVECTORIZER_RESOURCES_VERSION=sentence-transformers\/paraphrase-multilingual-MiniLM-L12-v2\ndocker compose -f docker-compose.multiminilml12v2.yml up\ndocker rm vectorizer-resources-init-job\n\n# INSTALL spDilaCamembert\ncat vectorizer.env\nVECTORIZER_RESOURCES_VERSION=oterrier\/sp-dila-camembert-base-gpl\ndocker compose -f docker-compose.spdilacamembertgpl.yml up\ndocker rm vectorizer-resources-init-job\n\n# INSTALL sentenceCamembertBase\ncat vectorizer.env\nVECTORIZER_RESOURCES_VERSION=dangvantuan\/sentence-camembert-base\ndocker compose -f docker-compose.sentencecamembertbase.yml up\ndocker rm vectorizer-resources-init-job\n\n# INSTALL bge-m3 (GPU only)\ncat vectorizer.env\nVECTORIZER_RESOURCES_VERSION=BAAI\/bge-m3\ndocker compose -f docker-compose.bge-m3.yml up\ndocker rm vectorizer-resources-init-job<\/code><\/pre>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\">\n<p>The variable <code>VECTORIZER_RESOURCES_VERSION<\/code> can be modified to indicate the model selection.<\/p>\n<\/blockquote>\n\n\n\n<div style=\"height:47px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n<style>.wp-block-kadence-spacer.kt-block-spacer-21_bc62f2-e4 .kt-block-spacer{height:20px;}.wp-block-kadence-spacer.kt-block-spacer-21_bc62f2-e4 .kt-divider{border-top-width:1px;height:1px;border-top-color:#eee;width:80%;border-top-style:solid;}<\/style>\n<div class=\"wp-block-kadence-spacer aligncenter kt-block-spacer-21_bc62f2-e4\"><div class=\"kt-block-spacer kt-block-spacer-halign-center\"><hr class=\"kt-divider\"\/><\/div><\/div>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"kairntech-platform-installation\">Kairntech platform installation<\/h2>\n\n\n\n<p>In order to download the different images needed to install the platform, you must first connect to dockerhub.<br>(The password to be used <strong>will be delivered by Kairntech <\/strong>).<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>sudo su - kairntech\n\ncd \/opt\/sherpa\n\ndocker login\n\nusername: ktguestkt\n\npassword: <\/code><\/pre>\n\n\n\n<p>Once logged in, you can start downloading the images:<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>docker compose -f docker-compose.yml pull<\/code><\/pre>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\">\n<p>If you have deployed with authentication (MongoDB or ElasticSearch), for compatibility purpose, you&#8217;ll need to symlink <code>.env<\/code> file:<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>sudo su - kairntech\n\ncd \/opt\/sherpa\n\nln -s mongodb-credentials.env .env\n\ncat elasticsearch-credentials.env &gt;&gt; .env<\/code><\/pre>\n<\/blockquote>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<p>Finally, to start the platform, run:<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>docker compose -f docker-compose.yml up -d<\/code><\/pre>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<p>Once the platform is started, you can check the status of the containers; the following console output is given as an example. Some containers may not be present, depending on the kind of deployment you processed.<\/p>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>docker ps -a --format \"{{.ID}}\\t\\t{{.Names}}\\t\\t{{.Status}}\"\n\n79e235f82787        sherpa-core                           Up 20 sec\n\ne69f95855809        sherpa-crfsuite-suggester             Up 20 sec\nc9d95639c808        sherpa-entityfishing-suggester        Up 20 sec\n94e4574b95de        sherpa-fasttext-suggester             Up 20 sec\n\n8f13e72aeb0d        sherpa-phrasematcher-test-suggester   Up 20 sec\n0f49dec91340        sherpa-phrasematcher-train-suggester  Up 20 sec\naa08f1008770        sherpa-sklearn-test-suggester         Up 20 sec\n988976ef327d        sherpa-sklearn-train-suggester        Up 20 sec\nbed6169d9185        sherpa-spacy-test-suggester           Up 20 sec\n302bd98a44ab        sherpa-spacy-train-suggester          Up 20 sec\n7754162ae44c        sherpa-flair-test-suggester           Up 20 sec\n08d1ad415adb        sherpa-flair-train-suggester          Up 20 sec\n4835129a77c9        sherpa-bertopic-test-suggester        Up 20 sec\nb999a848044c        sherpa-bertopic-train-suggester       Up 20 sec\n\n0826e0dd9c85        sherpa-elasticsearch                  Up 20 sec\n7f781bf11ddf        sherpa-mongodb                        Up 20 sec\n\nd3b0e0557309        sherpa-builtins-importer              Up 20 sec\n\ncf075d3b06f4        sherpa-multirole                      Up 20 sec\nae1b24e0ccdb        sherpa-pymultirole                    Up 20 sec\n2a737b399388        sherpa-pymultirole-trf                Up 20 sec\nf43121e96544        sherpa-pymultirole-ner                Up 20 sec<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"<p>Supported Operating Systems The Kairntech platform has been successfully validated on the following operating systems, for both CPU and GPU deployments: Note: When deploying in a CPU-only environment, Docker-based virtualization removes most OS-level constraints. However, for GPU-based deployment, compatibility is restricted due to NVIDIA driver requirements. Only the above-listed OS versions are officially supported for [&hellip;]<\/p>\n","protected":false},"author":4,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-21","page","type-page","status-publish","hentry"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v26.8 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Installation Guide - Kairntech Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/kairntech.com\/doc\/installation-guide\/\" \/>\n<meta property=\"og:locale\" content=\"en_GB\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Installation Guide - Kairntech Documentation\" \/>\n<meta property=\"og:description\" content=\"Supported Operating Systems The Kairntech platform has been successfully validated on the following operating systems, for both CPU and GPU deployments: Note: When deploying in a CPU-only environment, Docker-based virtualization removes most OS-level constraints. However, for GPU-based deployment, compatibility is restricted due to NVIDIA driver requirements. Only the above-listed OS versions are officially supported for [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/kairntech.com\/doc\/installation-guide\/\" \/>\n<meta property=\"og:site_name\" content=\"Kairntech Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2026-01-24T18:10:43+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Estimated reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/kairntech.com\/doc\/installation-guide\/\",\"url\":\"https:\/\/kairntech.com\/doc\/installation-guide\/\",\"name\":\"Installation Guide - Kairntech Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/kairntech.com\/doc\/#website\"},\"datePublished\":\"2022-05-05T12:24:27+00:00\",\"dateModified\":\"2026-01-24T18:10:43+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/kairntech.com\/doc\/installation-guide\/#breadcrumb\"},\"inLanguage\":\"en-GB\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/kairntech.com\/doc\/installation-guide\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/kairntech.com\/doc\/installation-guide\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/kairntech.com\/doc\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Installation Guide\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/kairntech.com\/doc\/#website\",\"url\":\"https:\/\/kairntech.com\/doc\/\",\"name\":\"Kairntech Documentation\",\"description\":\"All the information you need to use Kairntech Software, methodology,  user and installation guides.\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/kairntech.com\/doc\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-GB\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Installation Guide - Kairntech Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/kairntech.com\/doc\/installation-guide\/","og_locale":"en_GB","og_type":"article","og_title":"Installation Guide - Kairntech Documentation","og_description":"Supported Operating Systems The Kairntech platform has been successfully validated on the following operating systems, for both CPU and GPU deployments: Note: When deploying in a CPU-only environment, Docker-based virtualization removes most OS-level constraints. However, for GPU-based deployment, compatibility is restricted due to NVIDIA driver requirements. Only the above-listed OS versions are officially supported for [&hellip;]","og_url":"https:\/\/kairntech.com\/doc\/installation-guide\/","og_site_name":"Kairntech Documentation","article_modified_time":"2026-01-24T18:10:43+00:00","twitter_card":"summary_large_image","twitter_misc":{"Estimated reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/kairntech.com\/doc\/installation-guide\/","url":"https:\/\/kairntech.com\/doc\/installation-guide\/","name":"Installation Guide - Kairntech Documentation","isPartOf":{"@id":"https:\/\/kairntech.com\/doc\/#website"},"datePublished":"2022-05-05T12:24:27+00:00","dateModified":"2026-01-24T18:10:43+00:00","breadcrumb":{"@id":"https:\/\/kairntech.com\/doc\/installation-guide\/#breadcrumb"},"inLanguage":"en-GB","potentialAction":[{"@type":"ReadAction","target":["https:\/\/kairntech.com\/doc\/installation-guide\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/kairntech.com\/doc\/installation-guide\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/kairntech.com\/doc\/"},{"@type":"ListItem","position":2,"name":"Installation Guide"}]},{"@type":"WebSite","@id":"https:\/\/kairntech.com\/doc\/#website","url":"https:\/\/kairntech.com\/doc\/","name":"Kairntech Documentation","description":"All the information you need to use Kairntech Software, methodology,  user and installation guides.","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/kairntech.com\/doc\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-GB"}]}},"jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/kairntech.com\/doc\/wp-json\/wp\/v2\/pages\/21","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/kairntech.com\/doc\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/kairntech.com\/doc\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/kairntech.com\/doc\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/kairntech.com\/doc\/wp-json\/wp\/v2\/comments?post=21"}],"version-history":[{"count":178,"href":"https:\/\/kairntech.com\/doc\/wp-json\/wp\/v2\/pages\/21\/revisions"}],"predecessor-version":[{"id":5688,"href":"https:\/\/kairntech.com\/doc\/wp-json\/wp\/v2\/pages\/21\/revisions\/5688"}],"wp:attachment":[{"href":"https:\/\/kairntech.com\/doc\/wp-json\/wp\/v2\/media?parent=21"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}