docs/custom-installers.html - gerrit/www.eclipse.org/che - Git at Google

 <!DOCTYPE html>
 <html>
 <head>
     <meta charset="utf-8">
 <meta http-equiv="X-UA-Compatible" content="IE=edge">
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta name="description" content="">
 <meta name="keywords" content="extensionsassemblydev-docs,  framework, overview, master, server, che server, framework">
 <title>Installers | Eclipse Che Documentation</title>
 <link rel="stylesheet" href="css/syntax.css">

 <link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" crossorigin="anonymous">
 <!--<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">-->
 <link rel="stylesheet" href="css/modern-business.css">
 <!-- Latest compiled and minified CSS -->
 <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
 <link rel="stylesheet" href="css/customstyles.css">
 <link rel="stylesheet" href="css/boxshadowproperties.css">
 <!-- most color styles are extracted out to here -->
 <link rel="stylesheet" href="css/theme-che.css">


     <link rel="stylesheet" href="/css/coderay.css" media="screen" type="text/css">

 <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js" crossorigin="anonymous"></script>

 <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js" crossorigin="anonymous"></script>
 <script src="js/jquery.navgoco.min.js"></script>


 <!-- Latest compiled and minified JavaScript -->
 <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
 <!-- Anchor.js -->
 <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js" crossorigin="anonymous"></script>
 <script src="js/toc.js"></script>
 <script src="js/customscripts.js"></script>

 <link rel="shortcut icon" href="che/docs/images/favicon.ico">

 <!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
 <!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
 <!--[if lt IE 9]>
 <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
 <script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
 <![endif]-->

 <link rel="alternate" type="application/rss+xml" title="che" href="http://0.0.0.0:4000/feed.xml">

     <script>
         $(document).ready(function() {
             // Initialize navgoco with default options
             $("#mysidebar").navgoco({
                 caretHtml: '',
                 accordion: true,
                 openClass: 'active', // open
                 save: false, // leave false or nav highlighting doesn't work right
                 cookie: {
                     name: 'navgoco',
                     expires: false,
                     path: '/'
                 },
                 slide: {
                     duration: 400,
                     easing: 'swing'
                 }
             });

             $("#collapseAll").click(function(e) {
                 e.preventDefault();
                 $("#mysidebar").navgoco('toggle', false);
             });

             $("#expandAll").click(function(e) {
                 e.preventDefault();
                 $("#mysidebar").navgoco('toggle', true);
             });

         });

     </script>
     <script>
         $(function () {
             $('[data-toggle="tooltip"]').tooltip()
         })
     </script>
     <script>
         $(document).ready(function() {
             $("#tg-sb-link").click(function() {
                 $("#tg-sb-sidebar").toggle();
                 $("#tg-sb-content").toggleClass('col-md-9');
                 $("#tg-sb-content").toggleClass('col-md-12');
                 $("#tg-sb-icon").toggleClass('fa-toggle-on');
                 $("#tg-sb-icon").toggleClass('fa-toggle-off');
             });
         });
     </script>


 </head>
 <body>
 <!-- Navigation -->
 <nav class="navbar navbar-inverse navbar-static-top">
     <div class="container topnavlinks">
         <div class="navbar-header">
             <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
                 <span class="sr-only">Toggle navigation</span>
                 <span class="icon-bar"></span>
                 <span class="icon-bar"></span>
                 <span class="icon-bar"></span>
             </button>
             <a class="fa fa-home fa-lg navbar-brand" href="index.html">&nbsp;<span class="projectTitle"> Eclipse Che Documentation</span></a>
         </div>
         <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
             <ul class="nav navbar-nav navbar-right">
                 <!-- toggle sidebar button -->
                 <li><a id="tg-sb-link" href="#"><i id="tg-sb-icon" class="fa fa-toggle-on"></i> Nav</a></li>
                 <!-- entries without drop-downs appear here -->


                 <li><a href="https://medium.com/eclipse-che-blog/" target="_blank">Blog</a></li>


                 <li><a href="https://github.com/eclipse/che" target="_blank">Source Code</a></li>


                 <!-- entries with drop-downs appear here -->
                 <!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->


                 <li class="dropdown">
                     <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Support<b class="caret"></b></a>
                     <ul class="dropdown-menu">


                         <li><a href="https://github.com/eclipse/che/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Akind%2Fbug" target="_blank">Known Bugs</a></li>


                         <li><a href="https://github.com/eclipse/che/issues/new" target="_blank">File an Issue</a></li>


                         <li><a href="https://stackoverflow.com/questions/tagged/eclipse-che" target="_blank">Che on StackOverflow</a></li>


                     </ul>
                 </li>


                 <!--
 			<li>


   <a class="email" title="Submit feedback" href="#" onclick="javascript:window.location='mailto:?subject= feedback&body=I have some feedback about the Installers page: ' + window.location.href;"><i class="fa fa-envelope-o"></i> Feedback</a>

 </li>
  -->

                 <!--comment out this block if you want to hide search-->
                 <li>
                     <!--start search-->
                     <div id="search-demo-container">
                         <input type="text" id="search-input" placeholder="search...">
                         <ul id="results-container"></ul>
                     </div>
                     <script src="js/jekyll-search.js" type="text/javascript"></script>
                     <script type="text/javascript">
                             SimpleJekyllSearch.init({
                                 searchInput: document.getElementById('search-input'),
                                 resultsContainer: document.getElementById('results-container'),
                                 dataSource: 'search.json',
                                 searchResultTemplate: '<li><a href="{url}" title="Installers">{title}</a></li>',
                     noResultsText: 'No results found.',
                             limit: 10,
                             fuzzy: true,
                     })
                     </script>
                     <!--end search-->
                 </li>
             </ul>
         </div>
         </div>
         <!-- /.container -->
 </nav>

 <!-- Page Content -->
 <div class="container">
   <div id="main">
     <!-- Content Row -->
     <div class="row">


             <!-- Sidebar Column -->
             <div class="col-md-3" id="tg-sb-sidebar">


 <ul id="mysidebar" class="nav">
   <li class="sidebarTitle"> </li>


   <li>
       <a href="#">Overview</a>
       <ul>


           <li><a href="index.html">Introduction</a></li>


           <li><a href="quick-start.html">Getting Started</a></li>


           <li><a href="single-multi-user.html">Single and Multi-User Flavors</a></li>


           <li><a href="infra-support.html">Supported Infrastructures</a></li>


       </ul>
    </li>


   <li>
       <a href="#">Che on Docker</a>
       <ul>


           <li><a href="docker-single-user.html">Docker - Single User</a></li>


           <li><a href="docker-multi-user.html">Docker - Multi User</a></li>


           <li><a href="docker-config.html">Docker - Configuration</a></li>


           <li><a href="docker-cli.html">Docker - CLI Reference</a></li>


       </ul>
    </li>


   <li>
       <a href="#">Che on Kubernetes</a>
       <ul>


           <li><a href="kubernetes-single-user.html">Kubernetes - Single User</a></li>


           <li><a href="kubernetes-multi-user.html">Kubernetes - Multi User</a></li>


           <li><a href="kubernetes-config.html">Kubernetes - Configuration</a></li>


           <li><a href="kubernetes-admin-guide.html">Kubernetes - Admin Guide</a></li>


       </ul>
    </li>


   <li>
       <a href="#">Che on OpenShift</a>
       <ul>


           <li><a href="openshift-single-user.html">OpenShift - Single User</a></li>


           <li><a href="openshift-multi-user.html">OpenShift - Multi User</a></li>


           <li><a href="openshift-config.html">OpenShift - Configuration</a></li>


           <li><a href="openshift-admin-guide.html">OpenShift - Admin Guide</a></li>


       </ul>
    </li>


   <li>
       <a href="#">User Management</a>
       <ul>


           <li><a href="user-management.html">Authentication and Authorization</a></li>


           <li><a href="authentication.html">Security Model</a></li>


           <li><a href="permissions.html">Permissions</a></li>


           <li><a href="organizations.html">Organizations in UD</a></li>


           <li><a href="resource-management.html">Resource Management</a></li>


       </ul>
    </li>


   <li>
       <a href="#">User Guides</a>
       <ul>


           <li><a href="creating-starting-workspaces.html">Creating and starting Workspaces</a></li>


           <li><a href="ide-projects.html">Projects</a></li>


           <li><a href="editor-code-assistance.html">Editor and Code-Assistance</a></li>


           <li><a href="dependency-management.html">Dependency Management</a></li>


           <li><a href="commands-ide-macro.html">Commands and IDE Macros</a></li>


           <li><a href="version-control.html">Version Control</a></li>


           <li><a href="debug.html">Debug</a></li>


       </ul>
    </li>


   <li>
       <a href="#">Workspace Administration</a>
       <ul>


           <li><a href="what-are-workspaces.html">Workspace Overview</a></li>


           <li><a href="stacks.html">Workspace - Stacks</a></li>


           <li><a href="recipes.html">Workspace - Recipes</a></li>


           <li><a href="servers.html">Workspace - Servers</a></li>


           <li><a href="installers.html">Workspace - Installers</a></li>


           <li><a href="volumes.html">Workspace - Volumes Mount</a></li>


           <li><a href="env-variables.html">Workspace - Environment Variables</a></li>


           <li><a href="projects.html">Workspace - Projects</a></li>


           <li><a href="workspaces-troubleshooting.html">Workspace - Troubleshooting</a></li>


           <li><a href="workspace-data-model.html">Workspace Data Model</a></li>


       </ul>
    </li>


   <li>
       <a href="#">Portable Workspaces</a>
       <ul>


           <li><a href="chedir-getting-started.html">Chedir - Getting Started</a></li>


           <li><a href="why-chedir.html">Chedir - Why Chedir?</a></li>


           <li><a href="chedir-installation.html">Chedir - Installation</a></li>


           <li><a href="chedir-project-setup.html">Chedir - Project Setup</a></li>


           <li><a href="chedir-up-and-down.html">Chedir - Up and Down</a></li>


           <li><a href="chefile.html">Chedir - Chefile</a></li>


           <li><a href="chedir-ssh.html">Chedir - SSH</a></li>


           <li><a href="factories-getting-started.html">Factory - Getting Started</a></li>


           <li><a href="creating-factories.html">Factory - Creating</a></li>


           <li><a href="factories_json_reference.html">Factory - JSON Reference</a></li>


       </ul>
    </li>


   <li>
       <a href="#">Developer Guides</a>
       <ul>


           <li><a href="framework-overview.html">Overview</a></li>


           <li><a href="rest-api.html">SDK - REST API</a></li>


           <li><a href="che-in-che-quickstart.html">SDK - Your First Plugin</a></li>


           <li><a href="build-reqs.html">SDK - Building Che</a></li>


           <li><a href="assemblies.html">SDK - Assemblies</a></li>


           <li><a href="logging.html">SDK - Logging</a></li>


           <li><a href="ide-extensions-gwt.html">SDK - GWT IDE Extensions</a></li>


           <li><a href="server-side-extensions.html">SDK - Server Side Extensions</a></li>


           <li class="active"><a href="custom-installers.html">SDK - Installers</a></li>


           <li><a href="project-types.html">SDK - Project Types</a></li>


           <li><a href="language-servers.html">SDK - Language Support</a></li>


           <li><a href="parts.html">IDE UI&#58 Parts</a></li>


           <li><a href="actions.html">IDE UI&#58 Actions</a></li>


       </ul>
    </li>


   <li>
       <a href="#">Dev Essentials</a>
       <ul>


           <li><a href="guice.html">Dependency Injection</a></li>


           <li><a href="dto.html">Transport&#58 DTO</a></li>


           <li><a href="json-rpc.html">Communication&#58 JSON-RPC</a></li>


           <li><a href="handling-projects-in-plugins.html">Handling Projects in Plugins</a></li>


           <li><a href="dao.html">Persistence, DAO</a></li>


           <li><a href="properties.html">Properties</a></li>


       </ul>
    </li>


   <li>
       <a href="#">Infrastructure and SPI</a>
       <ul>


           <li><a href="spi_overview.html">Overview</a></li>


           <li><a href="spi-implementation.html">Implementation Notes</a></li>


       </ul>
    </li>


       <!-- if you aren't using the accordion, uncomment this block:
          <p class="external">
              <a href="#" id="collapseAll">Collapse All</a> | <a href="#" id="expandAll">Expand All</a>
          </p>
          -->
 </ul>

 <!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.-->
 <script>$("li.active").parents('li').toggleClass("active");</script>

             </div>


         <!-- Content Column -->
         <div class="col-md-9" id="tg-sb-content">
             <div class="post-header">
    <h1 class="post-title-main">Installers</h1>
 </div>


 <div class="post-content">


 <!-- this handles the automatic toc. use ## for subheads to auto-generate the on-page minitoc. if you use html tags, you must supply an ID for the heading element in order for it to appear in the minitoc. -->
 <script>
 $( document ).ready(function() {
   // Handler for .ready() called.
 $('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2' });
 /* this offset helps account for the space taken up by the floating toolbar. */
 $('#toc').on('click', 'a', function() {
   var target = $(this.getAttribute('href'))
     , scroll_target = target.offset().top
   $(window).scrollTop(scroll_target - 10);
   return false
 })

 });
 </script>

 <div id="toc"></div>


     <!--


      -->

   <div class="paragraph">
 <p>Now that you have made yourself familiar with <a href="installers.html">Installer</a> concept and usage, let’s take a closer look at implementing custom ones.</p>
 </div>
 <div class="paragraph">
 <p>Let’s take a closer look of a custom installer named <code>Curl</code>:</p>
 </div>
 <div class="paragraph">
 <p>The installer can be split into description in json format and shell script.</p>
 </div>
 <div class="paragraph">
 <p>The description has the following format:</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="CodeRay highlight"><code data-lang="json">{
   <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">org.eclipse.che.curl</span><span class="delimiter">&quot;</span></span>,
   <span class="key"><span class="delimiter">&quot;</span><span class="content">version</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">1.0.0</span><span class="delimiter">&quot;</span></span>,
   <span class="key"><span class="delimiter">&quot;</span><span class="content">name</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">Curl</span><span class="delimiter">&quot;</span></span>,
   <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">Embedded Curl</span><span class="delimiter">&quot;</span></span>,
   <span class="key"><span class="delimiter">&quot;</span><span class="content">dependencies</span><span class="delimiter">&quot;</span></span>: [],
   <span class="key"><span class="delimiter">&quot;</span><span class="content">properties</span><span class="delimiter">&quot;</span></span>: {},
   <span class="key"><span class="delimiter">&quot;</span><span class="content">servers</span><span class="delimiter">&quot;</span></span>: {}
 }</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>As you can see it has the following fields:</p>
 </div>
 <div class="ulist">
 <ul>
 <li>
 <p>id - unique value that identifier an installer;</p>
 </li>
 <li>
 <p>version - version of the installer;</p>
 </li>
 <li>
 <p>name - readable name of the installer;</p>
 </li>
 <li>
 <p>description - description of the installer;</p>
 </li>
 <li>
 <p>dependencies - declare dependencies to other installers;</p>
 </li>
 <li>
 <p>properties - key:value map, where installer is able to store custom specific fields;</p>
 </li>
 <li>
 <p>servers - list of servers which will be started by the installer.</p>
 </li>
 </ul>
 </div>
 <div class="paragraph">
 <p>The second item in resources is an installer script. It’s a shell script that will do all required system changes:</p>
 </div>
 <div class="paragraph">
 <p>Here is an example of script that installs <code>Curl</code> inside a machine:</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="CodeRay highlight"><code data-lang="shell">is_current_user_root() {
     test &quot;$(id -u)&quot; = 0
 }

 is_current_user_sudoer() {
     sudo -n true &gt; /dev/null 2&gt;&amp;1
 }

 set_sudo_command() {
     if is_current_user_sudoer &amp;&amp; ! is_current_user_root; then SUDO=&quot;sudo -E&quot;; else unset SUDO; fi
 }

 set_sudo_command
 unset PACKAGES

 CURL_INSTALLED=false
 command -v curl &gt;/dev/null 2&gt;&amp;1 &amp;&amp; CURL_INSTALLED=true

 # no curl, install it
 if [ ${CURL_INSTALLED} = false ]; then
   PACKAGES=${PACKAGES}&quot; curl&quot;;
   CURL_INSTALLED=true
 else
   echo &quot;Curl is already installed&quot;
   exit 0
 fi

 command -v yum &gt;/dev/null 2&gt;&amp;1 &amp;&amp; YUM_INSTALLED=true
 command -v apt-get &gt;/dev/null 2&gt;&amp;1 &amp;&amp; APT_GET_INSTALLED=true
 command -v dnf &gt;/dev/null 2&gt;&amp;1 &amp;&amp; DNF_INSTALLED=true
 command -v zypper &gt;/dev/null 2&gt;&amp;1 &amp;&amp; ZYPPER_INSTALLED=true


 if [ ${YUM_INSTALLED} = false ]; then
   ${SUDO} yum install ${PACKAGES};

 elif [ ${APT_GET_INSTALLED} = false ]; then
   ${SUDO} apt-get update;
   ${SUDO} apt-get -y install ${PACKAGES};

 elif [ ${DNF_INSTALLED} = false ]; then
   ${SUDO} dnf -y install ${PACKAGES};

 elif [ ${ZYPPER_INSTALLED} = false ]; then
   ${SUDO} zypper install -y ${PACKAGES};

 else
     &gt;&amp;2 echo &quot;Any of Yum, Apt-get, Dnf, Zypper package manager is not available&quot;
     exit 1
 fi

 echo &quot;Curl is installed successfully&quot;</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>And here is another installer which launches a web server and depends on another installer. Here is content of description json file:</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="CodeRay highlight"><code data-lang="json">{
   <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">org.eclipse.che.tomcat</span><span class="delimiter">&quot;</span></span>,
   <span class="key"><span class="delimiter">&quot;</span><span class="content">version</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">8.5.24</span><span class="delimiter">&quot;</span></span>,
   <span class="key"><span class="delimiter">&quot;</span><span class="content">name</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">Tomcat</span><span class="delimiter">&quot;</span></span>,
   <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">Embedded tomcat server</span><span class="delimiter">&quot;</span></span>,
   <span class="key"><span class="delimiter">&quot;</span><span class="content">dependencies</span><span class="delimiter">&quot;</span></span>: [<span class="string"><span class="delimiter">&quot;</span><span class="content">org.eclipse.che.curl</span><span class="delimiter">&quot;</span></span>],
   <span class="key"><span class="delimiter">&quot;</span><span class="content">properties</span><span class="delimiter">&quot;</span></span>: {},
   <span class="key"><span class="delimiter">&quot;</span><span class="content">servers</span><span class="delimiter">&quot;</span></span>: {
     <span class="key"><span class="delimiter">&quot;</span><span class="content">tomcat</span><span class="delimiter">&quot;</span></span>: {
       <span class="key"><span class="delimiter">&quot;</span><span class="content">port</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">8090/tcp</span><span class="delimiter">&quot;</span></span>,
       <span class="key"><span class="delimiter">&quot;</span><span class="content">protocol</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http</span><span class="delimiter">&quot;</span></span>,
       <span class="key"><span class="delimiter">&quot;</span><span class="content">path</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">/</span><span class="delimiter">&quot;</span></span>
     }
   }
 }</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>This installer needs curl to download tomcat binaries, so it is declared in <code>dependencies</code> field. If an installer depends on other installers, then all required installers will be launched automatically even if a user has not configured it. All installers which are defined as <code>dependencies</code> will be launched before launching the dependent one.</p>
 </div>
 <div class="paragraph">
 <p>Bootstrapper that launches installers tries to connect to all declared servers. No user input is required. Start of a workspace fails if any of servers are not accessible on defined ports during configured timeout.</p>
 </div>
 <div class="paragraph">
 <p>Installers servers may conflict, for example, two installers start servers on the same port. Then, infrastructure may want to be able reconfigure servers in its own way. So installer must expect environment variable with port for server launching or launch server on a default port if it is absent.</p>
 </div>
 <div class="paragraph">
 <p>The environment variable name has the following format <code>CHE_SERVER_{NORMALISED_SERVER_NAME}_PORT</code>. Where <code>NORMALISED_SERVER_NAME</code> is a server name in the upper case where all characters which are not Latin letters or digits replaced with <code>_</code> symbol.</p>
 </div>
 <div class="paragraph">
 <p>Here is an installer script that downloads Tomcat binaries with <code>Curl</code>, configures to use free port and launches it.</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="CodeRay highlight"><code data-lang="bash">TOMCAT_VERSION=8.5.24
 TOMCAT_BINARIES_URL=http://apache.volia.net/tomcat/tomcat-8/v8.5.24/bin/apache-tomcat-$TOMCAT_VERSION.tar.gz

 TARGET_FOLDER=~/tomcat
 mkdir -p $TARGET_FOLDER

 echo &quot;Downloading Tomcat $TOMCAT_VERSION into $TARGET_FOLDER&quot;
 curl $TOMCAT_BINARIES_URL | tar  xzf - -C ${TARGET_FOLDER}
 TOMCAT_FOLDER=$TARGET_FOLDER/apache-tomcat-$TOMCAT_VERSION

 echo &quot;Tomcat $TOMCAT_VERSION is downloaded and unpacked into $TOMCAT_FOLDER&quot;

 DEFAULT_TOMCAT_SERVER_PORT=8090
 TOMCAT_SERVER_PORT=${CHE_SERVER_TOMCAT_PORT:-${DEFAULT_TOMCAT_SERVER_PORT}}

 // configure Tomcat
 sed -i &quot;s/port=\&quot;8080\&quot;/port=\&quot;${TOMCAT_SERVER_PORT}\&quot;/g&quot; $TOMCAT_FOLDER/conf/server.xml

 echo &quot;Tomcat $TOMCAT_VERSION is configured to use $TOMCAT_SERVER_PORT port&quot;

 $TOMCAT_FOLDER/bin/catalina.sh run</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>An installer can be included into Che assembly or added to particular Che Server via REST API.</p>
 </div>
 <div class="paragraph">
 <p>To include an installer into Che assembly, two files are required in Che Server resources: installer description in json format and its script. The files must be named in the following way: <code>{INSTALLER_ID}.json</code> for description file and <code>{INSTALLER_ID}.script.sh</code> for script file. These files should be placed into <code>/installers/{INSTALLER_VERSION}</code> folder.</p>
 </div>
 <div class="paragraph">
 <p>Here is an example of maven module structure:</p>
 </div>
 <div class="imageblock">
 <div class="content">
 <img src="/che/docs/images/extensibility/installers/curl-installer-module.png" alt="curl installer module">
 </div>
 </div>
 <div class="paragraph">
 <p>The it is needed to add the corresponding maven module to Workspace Master War archive</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="CodeRay highlight"><code data-lang="xml"><span class="tag">&lt;project</span> <span class="attribute-name">...</span><span class="tag">&gt;</span>
   <span class="tag">&lt;parent&gt;</span>
     <span class="tag">&lt;artifactId&gt;</span>che-assembly-parent<span class="tag">&lt;/artifactId&gt;</span>
     <span class="tag">&lt;groupId&gt;</span>org.eclipse.che<span class="tag">&lt;/groupId&gt;</span>
     <span class="tag">&lt;version&gt;</span>6.0.X<span class="tag">&lt;/version&gt;</span>
   <span class="tag">&lt;/parent&gt;</span>
   <span class="tag">&lt;artifactId&gt;</span>assembly-wsmaster-war<span class="tag">&lt;/artifactId&gt;</span>
   <span class="tag">&lt;packaging&gt;</span>war<span class="tag">&lt;/packaging&gt;</span>
   <span class="tag">&lt;name&gt;</span>Che IDE :: Compiling WS Master WAR
   <span class="tag">&lt;dependencies&gt;</span>
     <span class="tag">&lt;dependency&gt;</span>
       <span class="tag">&lt;groupId&gt;</span>org.eclipse.che<span class="tag">&lt;/groupId&gt;</span>
       <span class="tag">&lt;artifactId&gt;</span>installer-tomcat<span class="tag">&lt;/artifactId&gt;</span>
     <span class="tag">&lt;/dependency&gt;</span>
     <span class="tag">&lt;dependency&gt;</span>
       <span class="tag">&lt;groupId&gt;</span>org.eclipse.che<span class="tag">&lt;/groupId&gt;</span>
       <span class="tag">&lt;artifactId&gt;</span>installer-tomcat<span class="tag">&lt;/artifactId&gt;</span>
     <span class="tag">&lt;/dependency&gt;</span>
   <span class="tag">&lt;/dependencies&gt;</span>
 <span class="tag">&lt;/project&gt;</span></code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>Also as it was mentioned an installer can be added via REST API or using Swagger:</p>
 </div>
 <div class="imageblock">
 <div class="content">
 <img src="/che/docs/images/extensibility/installers/add-installer-swagger.png" alt="add installer swagger">
 </div>
 </div>

     <div class="tags">

         <b>Tags: </b>


         <a href="tag_extensions.html" class="btn btn-default navbar-btn cursorNorm" role="button">extensions</a>


         <a href="tag_assembly.html" class="btn btn-default navbar-btn cursorNorm" role="button">assembly</a>


         <a href="tag_dev-docs.html" class="btn btn-default navbar-btn cursorNorm" role="button">dev-docs</a>


     </div>

 <!--
  -->

 </div>

 <hr class="shaded"/>

 <footer>
             <div class="row">
                 <div class="col-lg-12 footer">
                     Eclipse Che - Documentation <br/>
                     Site last generated: Sep 13, 2018 <br/>
                     <hr>
                     <a href="http://www.eclipse.org" target="_blank">Eclipse Foundation</a><br/>
                     <a href="http://www.eclipse.org/legal/privacy.php" target="_blank">Privacy Policy</a><br/>
                     <a href="http://www.eclipse.org/legal/termsofuse.php" target="_blank">Terms of Use</a><br/>
                     <a href="https://www.eclipse.org/legal/epl-2.0/" target="_blank">Eclipse Public License</a><br/>
                     <a href="http://www.eclipse.org/legal" target="_blank">Legal Resources</a><br/>
                 </div>
             </div>
 </footer>


     <!-- /.row -->
 </div>
 <!-- /.container -->
 </div>
 <!-- /#main -->
     </div>

 </body>

 </html>