From e41e13d4d34c41f498933a5e7a86524e8b7b076d Mon Sep 17 00:00:00 2001 From: Tyler Jewell Date: Wed, 26 Aug 2015 10:14:02 -0700 Subject: [PATCH] Updated README with latest positioning. --- assembly-sdk/src/assembly/README.txt | 192 ++++++++------------------- 1 file changed, 55 insertions(+), 137 deletions(-) diff --git a/assembly-sdk/src/assembly/README.txt b/assembly-sdk/src/assembly/README.txt index 25f90af3595..5e0b9d64961 100644 --- a/assembly-sdk/src/assembly/README.txt +++ b/assembly-sdk/src/assembly/README.txt @@ -8,172 +8,90 @@ Codenvy, S.A. - initial API and implementation ========================================================================== - Codenvy Platform SDK - ------------------------ - Build Your Own Cloud IDE +ECLIPSE CHE +High performance, open source developer environments in the cloud. +http://www.eclipse.org/che/ + +====== +About +====== +1. Cloud IDE. Use your browser to program on any machine in any language. Edit build, debug and deploy projects bound to source repositories. + +2. Workspace Server. Create developer environments with APIs. Add your project types, embed custom commands and host on any infrastructure. + +3. Plug-Ins. Use Che's built-in language plug-ins or write packaged extensions that transform Che's IDE into new tools and assemblies. ============= Requirements ============= - - * Java Platform, Standard Edition 7 Development Kit (JDK 7) or later; - * Apache Maven version 3 or later. - +1. Java Platform, Standard Edition 8 Development Kit (JDK 8) or later; +2. Apache Maven version 3 or later. =========== Installing =========== +1. Download and unpack a binary distribution of Eclipse Che. +2. A directory called "che-sdk-[version]" will be created. -1. Download and install JDK 7. - -1.1. Download JDK, release version 7 or later, from - http://www.oracle.com/technetwork/java/javase/downloads/index.html. - -1.2. Install JDK according to the instructions included with the release. - -2. Download and install Apache Maven. - -2.1. Download Apache Maven, release version 3 or later, from - http://maven.apache.org/download.cgi. - -2.2. Install Apache Maven according to the instructions included with the release. - -3. Make sure JAVA_HOME is set to the location of your JRE. - Make sure M2_HOME is set to the location of your Maven. +================== +Build From Source +================== +You can also build a Che assembly from source. -4. Download and unpack Codenvy Platform SDK. - -4.1. Download a binary distribution of Codenvy Platform SDK. - -4.2. Unpack the archive where you would like to store the binaries. - A directory called "codenvy-sdk-[version]" will be created. +1. Visit http://github.com/codenvy/che. +2. Follow instructions for building Che. =================== Running & Stopping =================== - -1. In order to launch a Codenvy Platform SDK, start Tomcat: +1. Launch Tomcat: On *nix: - ./che.sh start + ./che.sh start -* This script will also download and unpack another Tomcat which is used as runtime for apps and extensions launched in Codenvy SDK. This step will be skipped if you already already done so. +On Windows: + ./che.bat start -After launching, Codenvy Platform SDK application will be available at http://localhost:8080/ +Che will be available at http://localhost:8080/ -2. To stop a Codenvy Platform SDK application, execute the following command: +2. To stop: On *nix: - ./che.sh stop - -========================================================= -How to configure oAuth with GitHub and SSH key management -========================================================= - -* Go to GitHub.com and login to your account - -* In account Settings, find Applications menu on the left - -* Click register a new application (if you don't have any) - -* Enter application name - -* Homepage URL should be - -===================== -http://localhost:8080 -===================== - -* Authorization callback URL should be - -======================================================= -http://localhost:8080/api/oauth/callback -======================================================= + ./che.sh stop -* Having registered or updated the app, you will have Client ID and Client Secret in the top right corner of the application page on GitHub +On Windows: + ./che.bat stop -* Copy those values to a file located in conf folder of the SDK Tomcat package - /conf/github_client_secrets.json +====================================== +Configure Properties, Storage & oAuth +====================================== +1. System properties: https://eclipse-che.readme.io/docs/configuration#configuration-files +2. Workspace root: https://eclipse-che.readme.io/docs/configuration#workspace-root-location +3. Project storage: https://eclipse-che.readme.io/docs/configuration#project-storage-location +4. User profile: https://eclipse-che.readme.io/docs/configuration#user-profile-location +5. GitHub oAuth: https://eclipse-che.readme.io/docs/configuration#github-oauth -* By default, values for Client ID and Client Secret are filled with "***". You need to replace those with real values obtained from GitHub application settings. +======================== +Add / Remove Extensions +======================== +1. Get JAR file of plug-in, or, create and build one. https://eclipse-che.readme.io/docs/extension-development-workflow -=================================================================== -Local Storage for Projects, Preferences, GitHub Tokens and SSH keys -=================================================================== +2. Place JAR files into /ext/ directory. -Codenvy SDK provides configuration file codenvy-api-configuration.properties located at webapps/api/WEB-INF/classes/codenvy with a set of parameters having default values. To persist local configuration settings each time a new SDK version is downloaded, this file should be copied to a permanent location, and a new local environment variable should be added: - -export CHE_LOCAL_CONF_DIR=”[path to a location where config file is stored]“, for example: - -export CHE_LOCAL_CONF_DIR=”/home/eugene/.codenvy” - -====================== -Local Projects Storage -====================== -In configuration file: - -vfs.local.fs_root_dir=${catalina.base}/temp/fs-root -vfs.local.fs_index_root_dir=${catalina.base}/temp/fs-root - -replace with - -vfs.local.fs_root_dir=/home/eugene/SDK/.projects -vfs.local.fs_index_root_dir=/home/eugene/SDK/.projects - -============================================== -Local Storage for GitHub Client ID and Secrets -============================================== - -In configuration file: - -Replace *** with real values obtained from a registered GitHub app: - -#security -oauth.github.clientid=*** -oauth.github.clientsecret=*** -oauth.github.authuri= https://github.com/login/oauth/authorize -oauth.github.tokenuri= https://github.com/login/oauth/access_token -oauth.github.redirecturis= http://localhost:8080/api/oauth/callback - -================================================== -Local User Profile: Theme Preferences and SSH Keys -================================================== - -User preferences are stored in a profile which is a JSON file profile.json. Such preferences include but (not limited to) SSH keys and Themes. By default, the profile is stored in temp folder in Tomcat root, however, you can specify its new permanent location in che.properties and actually move it there: - -user.local.db=${catalina.base}/temp - -replace with - - user.local.db=/your/local/path/ - -=============================================== -Contribute 3rd-party extensions to Codenvy IDE -=============================================== - -1. To contribute 3rd-party extensions to Codenvy IDE, one need to do the following steps: - -1.1. Place an appropriate jar-files into "ext" directory. - -1.2. Execute the following script: +3. Execute extension installation script: On *nix: - ./extInstall.sh - -1.3. Restart Codenvy IDE if it is currently running. - -================= -Update Extensions -================= + ./extInstall.sh -1. Launch extension at Run menu -2. Click extension URL in the Output console -3. Click Update Extension button in the runner instance -4. The extension will be recompiled which may take around 1 minute +On Windows: + ./extInstall.bat -=============================== -Codenvy Platform SDK Resources -=============================== +4. Restart Che. -SDK Docs: http://docs.codenvy.com/sdk/ -Codenvy Platform API Reference: http://docs.codenvy.com/ide/site/apidocs/ +========== +Resources +========== +Home Page: http://eclipse.org/che +Docs: https://eclipse-che.readme.io/docs +Source: http://github.com/codenvy/che