blob: c08c00d46570f132b1917ae1df6fd54c6f629925 [file] [log] [blame]
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="Download and install Eclipse Che for Windows, Mac and Linux.">
<!-- Favicons etc. -->
<link rel="icon" href="../images/ico/16x16.png">
<link rel="icon" sizes="16x16 32x32 64x64" href="../images/ico/16x16.png">
<link rel="apple-touch-icon" sizes="57x57" href="../images/ico/57x57.png">
<link rel="apple-touch-icon" sizes="60x60" href="../images/ico/60x60.png">
<link rel="apple-touch-icon" sizes="72x72" href="../images/ico/72x72.png">
<link rel="apple-touch-icon" sizes="76x76" href="../images/ico/76x76.png">
<link rel="apple-touch-icon" sizes="114x114" href="../images/ico/114x114.png">
<link rel="apple-touch-icon" sizes="120x120" href="../images/ico/120x120.png">
<link rel="apple-touch-icon" sizes="144x144" href="../images/ico/144x144.png">
<link rel="apple-touch-icon" sizes="152x152" href="../images/ico/152x152.png">
<link rel="apple-touch-icon" sizes="180x180" href="../images/ico/180x180.png">
<link rel="icon" type="image/png" href="../images/ico/196x196.png" sizes="196x196">
<link rel="icon" type="image/png" href="../images/ico/192x192.png" sizes="192x192">
<link rel="icon" type="image/png" href="../images/ico/144x144.png" sizes="144x144">
<link rel="icon" type="image/png" href="../images/ico/96x96.png" sizes="96x96">
<link rel="icon" type="image/png" href="../images/ico/72x72.png" sizes="72x72">
<link rel="icon" type="image/png" href="../images/ico/48x48.png" sizes="48x48">
<link rel="icon" type="image/png" href="../images/ico/36x36.png" sizes="36x36">
<link rel="icon" type="image/png" href="../images/ico/32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="../images/ico/16x16.png" sizes="16x16">
<link rel="manifest" href="../images/ico/manifest.json">
<meta name="msapplication-TileColor" content="#ffffff">
<meta name="msapplication-TileImage" content="../images/ico/144x144.png">
<meta name="theme-color" content="#ffffff">
<!-- Always force latest IE rendering engine or request Chrome Frame -->
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
<!-- Use title if it's in the page YAML frontmatter -->
<title>Eclipse Che | Getting Started with Eclipse Che</title>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<link href='https://fonts.googleapis.com/css?family=Source+Sans+Pro:300' rel='stylesheet' type='text/css'>
<link href="../stylesheets/all.css" rel="stylesheet" />
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
<script src="../javascripts/bootstrap.min.js"></script>
<!-- Equal Height for Content Script -->
<script type="text/javascript">
$(document).ready(function(){
var leaderHeight = $(".leader p").height();
$(".border p").height( leaderHeight);
return false;
});
</script>
<!-- Tracking Snippets Below -->
<!-- GOOGLE TAG MANAGER -->
<noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-T9PJ53"
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-T9PJ53');</script>
<!-- END GOOGLE TAG MANAGER -->
<!-- MARKETO MUNCHKIN -->
<script type="text/javascript">
$.ajax({
url: '//munchkin.marketo.net/munchkin.js',
dataType: 'script',
cache: true,
success: function() {
Munchkin.init('519-AYY-549');
}
});
</script>
</head>
<body class="getting-started-cloud getting-started-cloud_index">
<header>
<div class="container-fluid">
<a class="logo" href="../"><img alt="Eclipse Che" src="../images/logo-eclipseche.svg" /></a>
<nav class="menu-mobile">
<a class="mobile-menu-toggle" data-toggle="collapse" aria-expanded="false" href="#mobileMenuItems"><i class="fa fa-bars"></i></a>
<ul class="mobile-menu-items collapse" id="mobileMenuItems">
<li><a href="../features/">Features</a></li>
<li><a href="../download/">Downloads</a></li>
<li><a target="_blank" href="https://eclipse-che.readme.io/docs/">Docs</a></li>
<li><a href="../community/">Community</a></li>
<li><a href="../blog/">Blog</a></li>
<li><a href="./">Get Started with <span>Eclipse Che<span></a></li>
</ul>
</nav>
<nav class="menu-desktop">
<ul>
<li><a href="../features/">Features</a></li>
<li><a href="../download/">Downloads</a></li>
<li><a target="_blank" href="https://eclipse-che.readme.io/docs/">Docs</a></li>
<li><a href="../community/">Community</a></li>
<li><a href="../blog/">Blog</a></li>
<li><iframe src="https://ghbtns.com/github-btn.html?user=eclipse&repo=che&type=star&count=true" frameborder="0" scrolling="0" width="100px" height="20px"></iframe></li>
<li><a class="btn-outline-dark" href="./">Get Started with <span>Eclipse Che<span></a></li>
</ul>
</nav>
</div> <!-- /.container-fluid -->
</header> <!-- /header -->
<div class="jumbotron">
<div class="container-fluid">
<h1>Getting Started with Eclipse Che</h1>
<h3>Use Eclipse Che workspaces at <a href="https://codenvy.com/" target="_blank">codenvy.com</a> or run Che on Windows, Mac or Linux.</h3>
</div> <!-- /.container-fluid -->
</div> <!-- /.jumbotron -->
<hr class="gray">
<div class="container-fluid content">
<ul class="row tabs">
<li class="col-xs-6 active">
<div class="cloud">
<h3 class="active"><a href="#tab1" data-toggle="tab">Try Eclipse Che in the Cloud</a></h3>
<p class="hidden-xs">Codenvy hosts Eclipse Che workspaces with free accounts.</p>
</div>
</li>
<li class="col-xs-6">
<div class="download">
<h3><a href="#tab2" data-toggle="tab">Download Eclipse Che</a></h3>
<p class="hidden-xs">Install binaries from an Eclipse mirror or build from source.</p>
</div>
</li>
</ul><!-- /.row -->
<div class="tab-content">
<div id="tab1" class="tab-pane fade in active">
<div class="row">
<div class="col-md-4 col-sm-6">
<div class="border media">
<div class="media-left">
<img src="http://placehold.it/50x50" alt="">
</div>
<div class="media-body">
<h4>Custom Workspace</h4>
<p class="small">Create workspaces for any programming language and framework.</p>
</div>
<a href="URL" class="btn-green">Create a free account</a>
</div>
</div> <!-- /.col -->
<div class="col-md-4 col-sm-6">
<div class="border media leader">
<div class="media-left">
<img src="../images/getting-started/spring.png" alt="Spring logo">
</div>
<div class="media-body">
<h4>Spring petclinic</h4>
<p class="small">A sample Spring-based application</p>
</div>
<a href="http://beta.codenvy.com/f?id=r6p0l1sfnwm99k94" class="btn-gray80">Launch Workspace</a>
</div>
</div> <!-- /.col -->
<div class="col-md-4 col-sm-6">
<div class="border media">
<div class="media-left">
<img src="../images/getting-started/net.png" alt="">
</div>
<div class="media-body">
<h4>.net application</h4>
<p class="small">A sample .net application</p>
</div>
<a href="http://beta.codenvy.com/f?id=mo97t9pkaijr7q1c" class="btn-gray80">Launch Workspace</a>
</div>
</div> <!-- /.col -->
<div class="col-md-4 col-sm-6">
<div class="border media">
<div class="media-left">
<img src="../images/getting-started/wildfly.png" alt="">
</div>
<div class="media-body">
<h4>Wildfly Application</h4>
<p class="small">Web application with Wildfly</p>
</div>
<a href="http://beta.codenvy.com/f?id=gbfcsdb76f2iy1f2" class="btn-gray80">Launch Workspace</a>
</div>
</div> <!-- /.col -->
<div class="col-md-4 col-sm-6">
<div class="border media">
<div class="media-left">
<img src="../images/getting-started/cpp.png" alt="">
</div>
<div class="media-body">
<h4>C++ console</h4>
<p class="small">A sample C++</p>
</div>
<a href="http://beta.codenvy.com/f?id=21w2nx87yto2xi1z" class="btn-gray80">Launch Workspace</a>
</div>
</div> <!-- /.col -->
<div class="col-md-4 col-sm-6">
<div class="border media">
<div class="media-left">
<img src="../images/getting-started/aspnet.png" alt="">
</div>
<div class="media-body">
<h4>asp.net example</h4>
<p class="small">A simple asp.net application</p>
</div>
<a href="http://beta.codenvy.com/f?id=m9ylnmjtmzvmq99i" class="btn-gray80">Launch Workspace</a>
</div>
</div> <!-- /.col -->
<div class="col-md-4 col-sm-6">
<div class="border media">
<div class="media-left">
<img src="../images/getting-started/php.png" alt="">
</div>
<div class="media-body">
<h4>Php example</h4>
<p class="small">A simple php example</p>
</div>
<a href="http://beta.codenvy.com/f?id=5ayat0naxlljn3p2" class="btn-gray80">Launch Workspace</a>
</div>
</div> <!-- /.col -->
<div class="col-md-4 col-sm-6">
<div class="border media">
<div class="media-left">
<img src="../images/getting-started/nodejs.png" alt="">
</div>
<div class="media-body">
<h4>nodejs example</h4>
<p class="small">A simple nodejs application</p>
</div>
<a href="http://beta.codenvy.com/f?id=af9r928owfulum17" class="btn-gray80">Launch Workspace</a>
</div>
</div> <!-- /.col -->
<div class="col-md-4 col-sm-6">
<div class="border media">
<div class="media-left">
<img src="../images/getting-started/spring.png" alt="">
</div>
<div class="media-body">
<h4>Spring boot</h4>
<p class="small">A Spring Boot application</p>
</div>
<a href="http://beta.codenvy.com/f?id=sz7uzyofb8olekkn" class="btn-gray80">Launch Workspace</a>
</div>
</div> <!-- /.col -->
<div class="col-md-4 col-sm-6">
<div class="border media">
<div class="media-left">
<img src="../images/getting-started/java.png" alt="">
</div>
<div class="media-body">
<h4>Java console</h4>
<p class="small">A simple java console application</p>
</div>
<a href="http://beta.codenvy.com/f?id=omriatu352kkthua" class="btn-gray80">Launch Workspace</a>
</div>
</div> <!-- /.col -->
<div class="col-md-4 col-sm-6">
<div class="border media">
<div class="media-left">
<img src="../images/getting-started/java.png" alt="">
</div>
<div class="media-body">
<h4>Java Gradle Console</h4>
<p class="small">A simple java app with Gradle</p>
</div>
<a href="http://beta.codenvy.com/f?id=5use7stej9bi9mxd" class="btn-gray80">Launch Workspace</a>
</div>
</div> <!-- /.col -->
</div><!-- /.row -->
</div> <!-- /#tab1 -->
<!-- DIVIDER FOR TABS -->
<!-- DIVIDER FOR TABS -->
<!-- DIVIDER FOR TABS -->
<!-- DIVIDER FOR TABS -->
<!-- DIVIDER FOR TABS -->
<!-- DIVIDER FOR TABS -->
<!-- DIVIDER FOR TABS -->
<!-- DIVIDER FOR TABS -->
<!-- DIVIDER FOR TABS -->
<!-- DIVIDER FOR TABS -->
<div id="tab2" class="tab-pane fade in">
<div class="block">
You can run Che natively (Tomcat) or in a container (Docker). We provide utilities to run both. If you are experienced with Docker, you can launch Che <b><a href="https://eclipse-che.readme.io/docs/usage-docker#using-docker-syntax">from our DockerHub image</a></b>. If you want to avoid installing prerequisites, you can launch Che <b><a href="https://github.com/mickaelbaron/vagrant-dockereclipseche-ubuntu64-build">from a Vagrant image</a></b>. And if you are into IoT, Che also <b><a href="https://github.com/mickaelbaron/vagrant-dockereclipseche-ubuntu64-build">runs on a Raspberry Pi</a></b>.
<div class="separator"></div>
<div class="block"></div>
<h2>How to Get Help</h2>
<ul>
<li><b>Issues:</b> We want you to have a phenomenal experience with Che. These instructions should work every time, but unexpected issues do happen. You can post <b><a href="https://github.com/eclipse/che/issues">issues to our GitHub page</a></b>. When posting, please <b><a href="https://github.com/eclipse/che/blob/master/CONTRIBUTING.md">follow the guidelines on issue reporting.</a></b></p></li>
<li><b>Documentation:</b> We put a lot of effort into maintaining our documentation. Please <b><a href="https://eclipse-che.readme.io/">check the docs</a></b> to see if your issue has an explanation. If there are missing docs, errors, or areas that need more elaboration, we'd love to get that feedback.community page.</a></b></p></li>
<li><b>Chat:</b> Che engineers hang out on Gitter, IRC and Slack. Contact details are on our <b><a href="https://www.eclipse.org/che/community/">community page.</a></b></p></li>
</ul>
<div class="separator"></div>
<div class="block"></div>
<h2>Avoid These Common Setup Gotchas</h2>
Our default installer tries to give you a perfect out of the box experience. Unexpected issues can prevent this, especially on Windows. There are some simple steps you can take to avoid common issues.
<ul>
<li><b>Windows/Mac:</b> VT-X/AMD-v must be enabled. Certain laptop vendors disable this setting by default. Che will provide you a VM error message when Che attempts to create a docker-machine VM if this is not properly set. You can change this <b><a href="https://docs.fedoraproject.org/en-US/Fedora/13/html/Virtualization_Guide/sect-Virtualization-Troubleshooting-Enabling_Intel_VT_and_AMD_V_virtualization_hardware_extensions_in_BIOS.html">in the BIOS</a></b>. You can test to see if virtualization is enabled on Windows by running <code>Task Manager > Performance</code>. There will be a field labeled 'virtualization'.</p></li>
<li><b>Windows:</b> VirtualBox can be finnicky on Windows. Our .exe installer installs VirtualBox for you. However, VirtualBox may still be unable to create a VM. The most common reason is <b><a href="http://stackoverflow.com/questions/33725779/failed-to-open-create-the-internal-network-vagrant-on-windows10">NDIS driver bugs</a></b>. You solve this by <b><a href="http://stackoverflow.com/questions/33725779/failed-to-open-create-the-internal-network-vagrant-on-windows10">re-installing VirtualBox</a></b>.</p></li>
<li><b>Windows:</b> Avoid installing Che into <code>Program Files</code>. In some enterprises there are admin permissions that interrupt Tomcat.</p></li>
<li><b>Windows:</b> If you install Che into a directory with <code>spaces</code>, we convert the directory to its Windows short form. This usually works, but some Windows mounted drives prevent this. Tomcat will fail as it has bugs that prevent it from resolving a CLASSPATH with spaces.</p></li>
<li><b>Mac:</b> Only install Che into <code>/Users</code> directory. This is due to a limitation of virtualbox on MacOSX. We need your project files and workspaces to be saved within <code>/Users</code> so that virtualbox can properly mount those files into the VM. You can install Che in other directories if you choose to the use the Fusion VM driver or if you tell Che to place the workspaces and projects into <code>/Users</code> by modifying your <code>che.properties</code> to <b><a href="https://eclipse-che.readme.io/docs/configuration#workspace-and-project-storage">alter the project storage location</a></b>.</p></li>
<li><b>Networking:</b> If you want to host Che for multiple users, you must <b><a href="https://eclipse-che.readme.io/docs/networking">change the networking configuration</a></b>.</p></li>
</ul>
<div class="separator"></div>
<div class="block"></div>
<h2>1. Install Che</h2>
<ul>
<li><b>Windows:</b> You must first <a href="https://eclipse-che.readme.io/docs/install-pre-reqs">install Java and Docker Toolbox</a>. Then install <b><a href="https://www.eclipse.org/che/download/">Che from a ZIP file</a></b>. Codenvy provides a <a href="https://install.codenvycorp.com/che/eclipse-che-latest.exe">wizard-based installer that installs both Che and its prerequisites</a>.</p></li>
<li><b>MacOS:</b> You must first <a href="https://eclipse-che.readme.io/docs/install-pre-reqs">install Java and Docker Toolbox</a>. Then install <b><a href="https://www.eclipse.org/che/download/">Che from a ZIP file</a></b>.</p></li>
<li><b>Linux:</b> You must first <a href="https://eclipse-che.readme.io/docs/install-pre-reqs">install Java</a>. Docker is already present on most Linux distributions. Then install <b><a href="https://www.eclipse.org/che/download/">Che from a ZIP file</a></b>.</p></li>
</ul>
<div class="separator"></div>
<div class="block"></div>
<h2>2. Run Che</h2>
<ul>
<li><b>Natively:</b> This launches the Che server and you access it through your browser over localhost. Che's startup utilities check dependencies and start Docker (which may also start a VM). Please follow the <b><a href="https://eclipse-che.readme.io/docs/usage#start">usage steps</a></b>. </p></li>
<li><b>In a Docker Container:</b> You can optionally run Che as a Docker container. The configuration is more challenging, but you can launch the container anywhere. You do not need Che installed to run this configuration. However, Che's scripts automate automate this configuration. We have syntax for using <b><a href="https://eclipse-che.readme.io/docs/usage-docker#using-che-scripts">Che's scripts</a></b>, or you can launch Che <b><a href="https://eclipse-che.readme.io/docs/usage-docker#using-docker-syntax">with Docker syntax</a></b>.</p></li>
<li><b>Success:</b> <code>http://localhost:8080</code> will open Che's workspace dashboard.</li>
<p><li><a href="../images/features/img-features-docker-powered.png"><img alt="" class="img-responsive" src="../images/features/img-features-docker-powered.png"/></a></p></li>
</ul>
<div class="separator"></div>
<div class="block"></div>
<h2>3. Create Workspaces and Projects</h2>
<ul>
<li><b>Create a Workspace:</b> Che provides a step-by-step wizard for creating your first workspace. It will pull from Che's all-in-one runtime stacks and then populate the workspace with projects that are ready to be compiled and run. We recommend that you start with the Java and Node templates.</p></li>
<li><b>Problems:</b> If the workspace creation fails, it's usually due to some sort of network configuration issue. There are multiple connections that exist between your browser and Che; Che and the Docker daemon; and between Che and the workspace runtime. We attempt to detect any networking issue when we can and provide helpful error messages. However, you may need to <b><a href="https://eclipse-che.readme.io/docs/networking">review the steps that Che takes</a></b> to make each connection to adjust them to your network.</p></li>
<li><b>Blank Projects:</b> The wizard is there to make sure that new projects are matched up with a runtime stack that will have the utilities necessary to edit, build and run your project. Many projects do not fit into an all-in-one stack of technology. As an alternative step, you can create a workspace with a blank runtime in the dashboard, import projects from within the IDE, and use the terminal to install additional tools.</p></li>
<li><b>Tutorials:</b> We provide step-by-step-by-step tutorials for getting started with Che using different technologies such as <a href="https://eclipse-che.readme.io/docs/get-started-with-java-and-che">Java</a>, <a href="https://eclipse-che.readme.io/docs/get-started-with-wordpress-and-che">Wordpress</a>, <a href="https://eclipse-che.readme.io/docs/get-started-with-nodejs-and-che">Node.js</a>, <a href="https://eclipse-che.readme.io/docs/che-and-subversion">Subversion</a>, and many more.</p></li>
</ul>
<div class="separator"></div>
<div class="block"></div>
<h2>4. Setup Hosted Che</h2>
<ul>
<li><b>Multiple Users:</b> You can set up Che to run as a server accessible by multiple users. You will need to <b><a href="https://eclipse-che.readme.io/docs/networking">review the steps that Che takes</a></b> to configure its networking, as you will need to ensure that each user's browser can make connections to Che and the workspaces that Che is managing.</p></li>
</ul>
<div class="separator"></div>
<div class="block"></div>
<h2>5. Customize Che</h2>
<ul>
<li><b>Plug-Ins:</b> Tool teams can create their own plug-ins to Che which will modify the server's behavior, alter the behavior of the IDE, or inject agents into the hosted workspaces. The most common activity is to add a new project type to Che, but plug-ins have been used to change the editor, add in version control features, and to implement vendor workflows. We have <b><a href="https://eclipse-che.readme.io/docs/plug-ins">instructions for writing plug-ins and extensions.</a></b></p></li>
<li><b>Assemblies:</b> You can create your own Che packages that you distribute. The package can be run as a Che server or as a desktop IDE. You can include your custom Che plug-ins or modify Che's core system and then include these changes into your assembly. You can <b><a href="https://eclipse-che.readme.io/docs/assemblies">create custom assemblies with the included SDK tools.</a></b></p></li>
</ul>
<div class="separator"></div>
<div class="block"></div>
<h2>6. Contribute to Che</h2>
<ul>
<li><b>Build Che From Source:</b> We love that idea. Che is a multi-module project, so you can build all of it, or just some of it. Start in the /assembly/assembly-main/ repository fo the fastest build. We maintain build instructions on our <b><a href="https://github.com/eclipse/che">GitHub repository.</a></b></p></li>
<li><b>Contribute:</b> We also love this. You can contribute in many ways: documentation, writing articles, creating plug-ins, solving bugs, or getting into the core feature roadmap. We maintain a document that outlines how <b><a href="https://github.com/eclipse/che/blob/master/CONTRIBUTING.md">you contribute to Che.</a></b> Also, our roadmap and weekly meeting minutes are maintained <b><a href="https://github.com/eclipse/che/wiki">on the Che wiki.</a></b></p></li>
</ul>
</div><!-- /#tab2 -->
</div><!-- /.tab-content -->
</div><!-- /.container-fluid -->
</div>
<div class="twitter-share">
<h6><i class="fa fa-twitter"></i> Was this page helpful? <a href="https://twitter.com/share">Share it on Twitter</a></h6>
</div>
<footer>
<div class="container-fluid">
<a class="logo" href="../"><img alt="Eclipse Che" src="../images/logo-eclipseche.svg" /></a>
<p class="tagline">Next-Generation Eclipse IDE</p>
<div class="sitemap">
<ul>
<li><a href="../features/">Features</a></li>
<li><a href="../download/">Downloads</a></li>
<li><a target="_blank" href="https://eclipse-che.readme.io/docs/">Docs</a></li>
<li><a href="../community/">Community</a></li>
<li><a href="../blog/">Blog</a></li>
</ul>
</div>
<a class="btn-outline-dark" href="./">Get Started with <span>Eclipse Che<span></a>
<div class="copyright">Copyright &copy; Eclipse Foundation 2016</div>
</div> <!-- /.container-fluid -->
</footer> <!-- /footer -->
</body>
</html>