Local Install

Install Eclipse Che on your computer or a development server.


Installation Types

Vagrant: The quickest way to try Che on any operating system.

Server: The best performance, especially on Docker-native systems.

Other: You can run Che in a Docker container. If you are into IoT, Che has a Samsung ARTIK IDE assembly and also runs on a Raspberry Pi.

Avoid These Common Setup Gotchas

Windows/Mac: VT-X/AMD-v must be enabled on your laptop. You can change this in the BIOS.

Windows: If VirtualBox fails to create a VM, the most common reason is NDIS driver bugs.

Proxies: Che must download software from the Internet. Configure Vagrant's proxy, or if installing as a server, setup Che's proxies.

1. Install Che

Vagrant: First install VirtualBox and Vagrant. Place Che's Vagrantfile in an empty directory. Execute vagrant up. The Vagrant installer configures Java, Docker, and the latest released version of Che.

Server: You must first install Java and Docker Toolbox. Then install Che from a ZIP file. Another option is that Codenvy provides a Windows wizard-based installer that installs both Che and its prerequisites.

Docker: There is syntax for launching a Che container using Che's scripts, or with Docker run syntax.

2. Run Che

Vagrant: Che is already running! http://192.168.28.30:8080 will open Che's dashboard.

Server: Follow these usage steps.

3. Create Workspaces and Projects

Create a Workspace: Che provides a step-by-step wizard for creating workspaces. The wizard creates workspaces with ready-to-go runtimes that contain projects that can be compiled, run and debugged. The Java and Node.JS stacks offer the most choice when starting.

Problems: If workspace creation fails, it's usually due to network configuration. Review the networking guide for configuring Che in different networks.

Tutorials: Step-by-step-by-step tutorials using different developer frameworks such as Java, Wordpress, Node.js, Subversion, and many more.

4. Setup Hosted Che

Multiple Users: Run Che as a server with its services remotely accessible. You must change Che's networking to ensure users browser can connect to Che and its workspaces.

5. Customize Che

Stacks: Add your own runtimes and templates.

Plug-Ins: Tool teams can create their own plug-ins which modify the server's behavior, alter the IDE, or inject agents into the hosted workspaces. Plug-ins can add new projects types, change the editor, add version control features and to implement vendor workflows. We have instructions for writing plug-ins and extensions.

Assemblies: You can create your own distributable packages of Che with custom stacks, plug-ins, or Che core modifications. The Samsung ARTIK IDE is an example. You can create custom assemblies with the SDK.

6. Contribute to Che

Build Che From Source: We love that idea. Che is a multi-module project, so you can build all of it, or just some of it. We maintain build instructions in our GitHub repository.

Contribute: 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 you contribute to Che. Also, our roadmap and weekly meeting minutes are maintained on the Che wiki.

How to Get Help

Issues

Sometimes the unexpected happens. If it does, post issues to our GitHub page. Please follow the issue reporting guidelines.

Documentation

We put a lot of effort into our docs. If there are improvements or errors, we'd love that feedback. Chat: Che engineers hang out on Gitter, IRC and Slack.

Chat

Che engineers hang out on Gitter, IRC and Slack.