| <!DOCTYPE html> |
| <html lang="en"> |
| <!-- Global site tag (gtag.js) - Google Analytics --> |
| <script async src="https://www.googletagmanager.com/gtag/js?id=UA-112407000-2"></script> |
| <script> |
| window.dataLayer = window.dataLayer || []; |
| |
| function gtag() { |
| dataLayer.push(arguments); |
| } |
| gtag('js', new Date()); |
| |
| gtag('config', 'UA-112407000-2'); |
| </script> |
| |
| <!-- Google Tag Manager --> |
| <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 = |
| 'https://www.googletagmanager.com/gtm.js?id=' + i + dl; |
| f.parentNode.insertBefore(j, f); |
| })(window, document, 'script', 'dataLayer', 'GTM-KS8HHSF'); |
| </script> |
| <!-- End Google Tag Manager --> |
| |
| <head> |
| <base href="/codewind/" /> |
| <title>Installing Codewind locally | Codewind</title> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="Installing Codewind locally"> |
| <meta name="keywords" content="linux, macos, windows, install, installing locally, installing linux, installing MacOS, installing Windows, Git, Docker Desktop, Docker Compose, start Codewi..."/> |
| <link rel="icon" type="image/png" sizes="16x16" href="images/favicon-16x16.png"> |
| <link rel="icon" type="image/png" sizes="32x32" href="images/favicon-32x32.png"> |
| <link href="https://fonts.googleapis.com/css?family=IBM+Plex+Sans:300,400,600&display=swap" rel="stylesheet"> |
| <!-- Bootstrap CSS CDN --> |
| <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" |
| integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous"> |
| <link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" /> |
| <link rel="stylesheet" href="css/styles.css"> |
| <link rel="stylesheet" href="css/docs.css"> |
| |
| |
| </head> |
| |
| <body data-spy="scroll" data-target="#toc"> |
| <!-- Google Tag Manager (noscript) --> |
| <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KS8HHSF" |
| height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript> |
| <!-- End Google Tag Manager (noscript) --> |
| <div class="main"> |
| <!-- Bootstrap NavBar --> |
| <nav class="navbar navbar-expand-lg navbar-light cw-banner fixed-top"> |
| <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" |
| data-target="#navbarNavDropdown" aria-controls="navbarNavDropdown" aria-expanded="false" |
| aria-label="Toggle navigation"> |
| <span class="navbar-toggler-icon"></span> |
| </button> |
| <a class="navbar-brand" href=""> |
| <img src="images/header-logo.svg" class="cw-header-logo" alt=""> |
| </a> |
| <div class="collapse navbar-collapse justify-content-end cw-navbar-padding" id="navbarNavDropdown"> |
| <ul class="navbar-nav cw-navbar-nav"> |
| <li class="nav-item cw-navbar-item cw-header-link"> |
| <a class="nav-link cw-nav-link" href="docindex.html">Docs</a> |
| </li> |
| <!-- li class="nav-item cw-navbar-item" id="download-li"> |
| <button onClick="window.location.href='https://microclimate.dev/download/codewind';" type="button" class="btn cw-download-button">Download</button> |
| <a href="https://microclimate.dev/download/codewind" class="nav-link cw-nav-link cw-download-link" href="#">Download</a> |
| </li> --> |
| |
| |
| <li class="nav-item cw-navbar-item" id="github-stars-button"> |
| <!-- Place this tag where you want the button to render. --> |
| <a class="github-button" href="https://github.com/eclipse/codewind" data-size="large" |
| data-show-count="true" aria-label="Star eclipse/codewind on GitHub">Star</a> |
| </li> |
| <!-- Smaller devices menu END --> |
| |
| </ul> |
| </div> |
| </nav> |
| <!-- NavBar END --> |
| |
| <!-- Bootstrap row --> |
| <div class="row" id="body-row"> |
| <!-- Sidebar --> |
| <div id="sidebar-container" class="bg-light"> |
| <!-- Bootstrap List Group --> |
| <ul class="list-group sticky-top bg-light cw-sticky-offset"> |
| <!-- Separator with title --> |
| <li class="list-group-item cw-sidebar-separator-title cw-text-gray d-flex bg-light align-items-center menu-collapsed"> |
| <small class="badge badge-success cw-margin-auto">DOCUMENTS</small> |
| </li> |
| <!-- /END Separator --> |
| <!-- Hard coded TOC --> |
| |
| <a href="#install_on_cloud" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Installing and Using Codewind on Cloud</span> |
| <span class="submenu-icon ml-auto"></span> |
| </div> |
| </a> |
| <div id="install_on_cloud" class="cw-sidebar-div cw-sidebar-submenu collapse" style=""> |
| <a href="installoncloud.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Installing and Using Codewind on Kubernetes</span> |
| </div> |
| </a> |
| <a href="supportingmultipleusers.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Support for multiple users</span> |
| </div> |
| </a> |
| <a href="viewkibanalogs.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Viewing logs using Kibana in IBM Cloud Private</span> |
| </div> |
| </a> |
| </div> |
| |
| <a href="installlocally.html" |
| |
| |
| class="cw-current-page bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Installing Codewind locally</span> |
| </div> |
| </a> |
| |
| <a href="#codewind_for_eclipse" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Codewind for Eclipse</span> |
| <span class="submenu-icon ml-auto"></span> |
| </div> |
| </a> |
| <div id="codewind_for_eclipse" class="cw-sidebar-div cw-sidebar-submenu collapse" style=""> |
| <a href="mdteclipseoverview.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Overview</span> |
| </div> |
| </a> |
| <a href="mdteclipsegettingstarted.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Installation and Getting Started</span> |
| </div> |
| </a> |
| <a href="mdteclipsemanagingprojects.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Managing Codewind projects</span> |
| </div> |
| </a> |
| <a href="mdteclipsebuildproject.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Building Codewind projects</span> |
| </div> |
| </a> |
| <a href="mdteclipsedebugproject.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Debugging Codewind projects</span> |
| </div> |
| </a> |
| <a href="mdteclipsetroubleshooting.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Troubleshooting</span> |
| </div> |
| </a> |
| <a href="mdteclipseuninstall.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Uninstalling</span> |
| </div> |
| </a> |
| </div> |
| |
| <a href="#codewind_for_vscode" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Codewind for VS Code</span> |
| <span class="submenu-icon ml-auto"></span> |
| </div> |
| </a> |
| <div id="codewind_for_vscode" class="cw-sidebar-div cw-sidebar-submenu collapse" style=""> |
| <a href="mdt-vsc-overview.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Overview</span> |
| </div> |
| </a> |
| <a href="mdt-vsc-getting-started.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Getting started</span> |
| </div> |
| </a> |
| <a href="mdt-vsc-tutorial.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Tutorial</span> |
| </div> |
| </a> |
| <a href="mdt-vsc-commands-overview.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Commands overview</span> |
| </div> |
| </a> |
| <a href="mdt-vsc-commands-project.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Project commands</span> |
| </div> |
| </a> |
| <a href="mdt-vsc-commands-restart-and-debug.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Restart and debug commands</span> |
| </div> |
| </a> |
| <a href="mdt-vsc-troubleshooting.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Troubleshooting</span> |
| </div> |
| </a> |
| <a href="mdt-vsc-uninstall.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Uninstalling</span> |
| </div> |
| </a> |
| </div> |
| |
| <a href="#configuring_codewind" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Configuring Codewind</span> |
| <span class="submenu-icon ml-auto"></span> |
| </div> |
| </a> |
| <div id="configuring_codewind" class="cw-sidebar-div cw-sidebar-submenu collapse" style=""> |
| <a href="usingadifferenttemplate" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Using a template repository of your own</span> |
| </div> |
| </a> |
| |
| </div> |
| |
| <a href="guide_performance.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Guide: Monitoring applications with the performance dashboard</span> |
| </div> |
| </a> |
| |
| <a href="uninstall.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Uninstalling Codewind</span> |
| </div> |
| </a> |
| |
| <a href="troubleshooting.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Troubleshooting</span> |
| </div> |
| </a> |
| |
| <a href="limitations.html" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Limitations</span> |
| </div> |
| </a> |
| |
| <!-- END hard coded TOC --> |
| |
| <!-- Separator without title --> |
| <li class="list-group-item cw-sidebar-separator-title bg-light cw-text-gray d-flex align-items-center menu-collapsed"> |
| <small class="badge badge-success cw-margin-auto">HELPFUL |
| LINKS</small> |
| </li> |
| <!-- /END Separator --> |
| <a href="https://projects.eclipse.org/proposals/eclipse-codewind" class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Eclipse Codewind project page</span> |
| </div> |
| </a> |
| <!-- Logo --> |
| <li class="list-group-item cw-logo-separator bg-light d-flex justify-content-center"> |
| <img src="images/header-logo.svg"> |
| </li> |
| </ul> |
| <!-- List Group END--> |
| </div> |
| <!-- sidebar-container END --> |
| <!-- MAIN --> |
| <div id="content-container" class="py-5 px-5"> |
| <div role="main"><h1 id="installing-codewind-locally">Installing Codewind locally</h1> |
| |
| <p>Codewind can be installed locally into Eclipse or into Visual Studio Code (VS Code).</p> |
| |
| <hr /> |
| <h2 id="prerequisites-for-linux-and-macos">Prerequisites for Linux and macOS</h2> |
| <ul> |
| <li>Linux or macOS, on x86_64 architecture only</li> |
| <li><a href="https://code.visualstudio.com/">Visual Studio Code</a> or <a href="https://www.eclipse.org/downloads/packages/release/">Eclipse IDE for Java EE Developers</a></li> |
| <li><a href="https://git-scm.com/">Git</a></li> |
| <li><a href="https://hub.docker.com/editions/community/docker-ce-desktop-mac">Docker Desktop for Mac</a> <strong>Version 17.06 minimum</strong></li> |
| <li><a href="https://docs.docker.com/compose/install/">Docker Compose</a></li> |
| <li>On Linux, follow the post-installation steps to <a href="https://docs.docker.com/engine/installation/linux/linux-postinstall/">run Docker as a non-root user</a>.</li> |
| </ul> |
| |
| <h2 id="prerequisites-for-windows">Prerequisites for Windows</h2> |
| <ul> |
| <li>Windows 10 and Windows Server 2016 are supported.</li> |
| <li><a href="https://code.visualstudio.com/">Visual Studio Code</a> or <a href="https://www.eclipse.org/downloads/packages/release/">Eclipse IDE for Java EE Developers</a></li> |
| <li><a href="https://git-scm.com/">Git</a></li> |
| <li>Install <a href="https://hub.docker.com/editions/community/docker-ce-desktop-windows">Docker Desktop for Windows</a>. |
| <ul> |
| <li>Use the default Linux containers setting. From the <strong>Docker for Windows</strong> menu, you can toggle between the Linux or Windows daemon. If your settings have been changed from the default, select <strong>Switch to Linux containers…</strong> to use Linux containers. Codewind only works with Linux containers.</li> |
| </ul> |
| </li> |
| <li>Enable your local disk drive for sharing in Docker. Open the <strong>Docker Settings</strong> window, click the <strong>Shared Drives</strong> tab, and select your <code class="highlighter-rouge">C:\</code> drive. Codewind creates it’s workspace in the root of the <code class="highlighter-rouge">C:\</code> drive. |
| <ul> |
| <li>For help resolving issues when using OS authentication setups such as AzureAD, see the <a href="troubleshooting#docker-shared-drive-not-accepting-os-credentials-for-windows">Troubleshooting page</a>.</li> |
| </ul> |
| </li> |
| <li>Disable Docker Experimental features. Open the <strong>Docker Settings</strong> window, click the <strong>Daemon</strong> tab, and clear the <strong>Experimental features</strong> check box.</li> |
| </ul> |
| |
| <h2 id="installing-into-vs-code">Installing into VS Code</h2> |
| |
| <p>To install Codewind for VS Code, see <a href="mdt-vsc-getting-started">Getting Started: Codewind for VS Code</a></p> |
| |
| <h2 id="installing-into-eclipse">Installing into Eclipse</h2> |
| |
| <p>To install Codewind for VS Code, see <a href="mdteclipsegettingstarted">Getting Started: Codewind for Eclipse</a></p> |
| |
| <hr /> |
| <h2 id="need-help">Need help?</h2> |
| <p>If you encounter problems with installing Codewind locally, check the <a href="troubleshooting#installing-codewind">Troubleshooting page</a>.</p> |
| </div> |
| </div> |
| </div> |
| <!-- Main Col END --> |
| <!-- footer row --> |
| <footer> |
| <div class="row" id="footer-div"> |
| <div class="col-lg-3 col-md-3 footer-col text-center"> |
| <div> |
| <div> |
| <a href="https://twitter.com/EclipseCodewind"><img src="images/twitter-logo.svg" class="cw-logo" /></a> |
| </div> |
| <div>@EclipseCodewind</div> |
| </div> |
| </div> |
| |
| <div class="col-lg-3 col-md-3 footer-col text-center"> |
| <div> |
| <div> |
| <a href="https://github.com/eclipse/codewind"><img src="images/github-logo.svg" |
| class="cw-logo" /></a> |
| </div> |
| <div>@Codewind</div> |
| </div> |
| </div> |
| <div class="col-lg-3 col-md-3 footer-col text-center"> |
| <div> |
| <div> |
| <a href="mailto:codewind-dev@eclipse.org"><img src="images/email-icon.svg" class="cw-logo" /></a> |
| </div> |
| <div>@Codewind</div> |
| </div> |
| </div> |
| |
| <div class="col-lg-3 col-md-3 footer-col text-center"> |
| <div class="cw-logo-mm" > |
| <div class="cw-logo-mm" > |
| <a href="mailto:codewind-dev@eclipse.org"><img src="images/mattermost-logo.png" class="cw-logo-mm" /></a> |
| </div> |
| </div> |
| </div> |
| |
| </div> |
| </footer> |
| <!-- footer row END --> <!-- Jquery --> |
| <script |
| src="https://code.jquery.com/jquery-3.4.1.min.js" |
| integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" |
| crossorigin="anonymous"></script> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js" |
| integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin="anonymous"> |
| </script> |
| |
| |
| |
| <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" |
| integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"> |
| </script> |
| |
| |
| <!-- Font Awesome JS --> |
| <script defer src="https://use.fontawesome.com/releases/v5.0.13/js/solid.js" |
| integrity="sha384-tzzSw1/Vo+0N5UhStP3bvwWPq+uvzCMfrN1fEFe+xBmv1C/AtVX5K0uZtmcHitFZ" crossorigin="anonymous"> |
| </script> |
| <script defer src="https://use.fontawesome.com/releases/v5.0.13/js/fontawesome.js" |
| integrity="sha384-6OIrr52G08NpOFSZdxxz1xdNSndlD4vdcf/q2myIUVO0VsqaGHJsB0RaBE01VTOY" crossorigin="anonymous"> |
| </script> |
| <!-- Place this tag in your head or just before your close body tag. --> |
| <script async defer src="https://buttons.github.io/buttons.js"></script> |
| |
| <script src="js/jquery.matchHeight-min.js"></script> |
| <script src="js/index.js"></script> |
| <script src="js/docs.js"></script> |
| |
| </div> |
| </body> |
| |
| </html> |