├── .gitignore ├── .gitpod.yml ├── .gitpod └── start_repo.sh ├── LICENSE ├── README.md ├── docs ├── _config.yml ├── index.html ├── script.js └── style.css └── repo.code-workspace /.gitignore: -------------------------------------------------------------------------------- 1 | .gitmodules 2 | -------------------------------------------------------------------------------- /.gitpod.yml: -------------------------------------------------------------------------------- 1 | image: ddev/ddev-gitpod-base:latest 2 | 3 | tasks: 4 | - name: ddev-gitpod-launcher 5 | before: | 6 | mkdir /workspace/code -p 7 | init: | 8 | sudo apt-get update && sudo apt install -y ddev 9 | ddev config global --omit-containers=ddev-router 10 | ddev debug download-images 11 | command: | 12 | export DDEV_NONINTERACTIVE=true 13 | ${GITPOD_REPO_ROOT}/.gitpod/start_repo.sh 14 | cd /workspace/code 15 | unset DDEV_NONINTERACTIVE 16 | 17 | workspaceLocation: ddev-gitpod-launcher/repo.code-workspace 18 | 19 | vscode: 20 | extensions: 21 | # PHP extension 22 | - felixfbecker.php-debug 23 | 24 | # Bash extensions 25 | - timonwong.shellcheck 26 | - rogalmic.bash-debug 27 | 28 | ports: 29 | # Ignore direct-build https port 30 | - port: 2222 31 | onOpen: ignore 32 | - port: 3306 33 | onOpen: ignore 34 | - port: 5432 35 | onOpen: ignore 36 | # Used by projector 37 | - port: 6942 38 | onOpen: ignore 39 | # Currently un-notified and unsupported mailpit https port 40 | - port: 8027 41 | onOpen: ignore 42 | # Currently un-notified and unsupported phpmyadmin http port 43 | - port: 8036 44 | onOpen: ignore 45 | # Currently un-notified and unsupported phpmyadmin https port 46 | - port: 8037 47 | onOpen: ignore 48 | # Direct-connect ddev-webserver port that is the main port 49 | - port: 8080 50 | onOpen: ignore 51 | # xhgui http port 52 | - port: 8143 53 | onOpen: ignore 54 | # xhgui https port 55 | - port: 8142 56 | onOpen: ignore 57 | # xdebug port 58 | - port: 9003 59 | onOpen: ignore 60 | # Adminer http port 61 | - port: 9100 62 | onOpen: ignore 63 | # Adminer https port 64 | - port: 9101 65 | onOpen: ignore 66 | # projector port 67 | - port: 9999 68 | -------------------------------------------------------------------------------- /.gitpod/start_repo.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | set -eu 4 | 5 | # Set up a given DDEV_REPO repository in gitpod (default to d10simple) 6 | # Run composer install if there's a composer.json 7 | # Import artifacts if there's a ${DDEV_REPO}-artifacts repository that can be checked out 8 | export DDEV_REPO=${DDEV_REPO:-https://github.com/ddev/d10simple} 9 | echo "Checking out repository ${DDEV_REPO}" 10 | DEFAULT_ARTIFACTS="${DDEV_REPO}-artifacts" 11 | export DDEV_ARTIFACTS=${DDEV_ARTIFACTS:-$DEFAULT_ARTIFACTS} 12 | echo "Attempting to get artifacts from ${DDEV_ARTIFACTS}" 13 | git clone ${DDEV_ARTIFACTS} "/tmp/${DDEV_ARTIFACTS##*/}" || echo "Could not check out artifacts repo ${DDEV_ARTIFACTS}" 14 | REPO_NAME=${DDEV_REPO##*/} 15 | export REPO_NAME="${REPO_NAME//_/-}" 16 | REPO_HOME=/workspace/code 17 | git clone ${DDEV_REPO} ${REPO_HOME} 18 | cd ${REPO_HOME} 19 | 20 | # Temporarily use an empty config.yaml to get ddev to use defaults 21 | # so we can do composer install. If there's already one there, 22 | # this does no harm. 23 | mkdir -p .ddev && touch .ddev/config.yaml 24 | 25 | # If there's a composer.json, do `ddev composer install` (which auto-starts projct) 26 | if [ -f composer.json ]; then 27 | ddev composer install 28 | fi 29 | # Now that composer install has been done, if we were using an empty 30 | # .ddev/config.yaml, we'll do a real ddev config 31 | if [ ! -s .ddev/config.yaml ]; then 32 | ddev config --project-name="${REPO_NAME}" 33 | fi 34 | ddev stop -a 35 | ddev start -y 36 | if [ -d "/tmp/${DDEV_ARTIFACTS##*/}" ]; then 37 | if [ -f "/tmp/${DDEV_ARTIFACTS##*/}/db.sql.gz" ]; then 38 | ddev import-db --file=/tmp/${DDEV_ARTIFACTS##*/}/db.sql.gz 39 | else 40 | echo "No db.sql.gz was provided in /tmp/${DDEV_ARTIFACTS##*/}" 41 | fi 42 | if [ -f "/tmp/${DDEV_ARTIFACTS##*/}/files.tgz" ]; then 43 | ddev import-files --source=/tmp/${DDEV_ARTIFACTS##*/}/files.tgz 44 | else 45 | echo "No files.tgz was provided in /tmp/${DDEV_ARTIFACTS##*/}" 46 | fi 47 | fi 48 | gp ports await 8080 && sleep 1 && gp preview $(gp url 8080) 49 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ddev-gitpod-launcher (archived) 2 | 3 | **Gitpod Classic has been deprecated and will be removed in April, 2025, so this repository and launcher will no longer be maintained** 4 | 5 | Launch and develop any web project in gitpod using ddev. 6 | 7 | 1. Get the https URL of the repository you want to work with. 8 | 2. (Optional) Provide database and user-generated files dumps in a (probably private) repository named `-artifacts`. For example. if you have a repository named `https://github.com/ddev/d10simple` the private artifacts git repository will be at `https://github.com/ddev/d10simple-artifacts`. 9 | * In that repository, check in `db.sql.gz` and `files.tgz` and push it. This only needs to be updated when you need to update it. 10 | * For future use, you may want to implement a `ddev pull` integration, for example for Acquia or Pantheon or Platform.sh or any other of the example [providers](https://github.com/ddev/ddev/tree/master/pkg/ddevapp/dotddev_assets/providers) (see [docs](https://ddev.readthedocs.io/en/latest/users/providers/provider-introduction/)). The git technique is used here because you may not have any other initial way to get database and files into gitpod until you set something up. 11 | 12 | Go to [DDEV gitpod launcher](https://ddev.github.io/ddev-gitpod-launcher/) to launch any website project and edit and develop it in gitpod. 13 | 14 | * If the project has a composer.json, the launcher will do a `ddev composer install` 15 | * If the project has a .ddev/config.yaml, it will be respected, otherwise a default will be auto-generated. 16 | 17 | ## Development 18 | 19 | While developing this repo, the following tips may be helpful. 20 | 21 | ### Test a branch of this repo 22 | 23 | 1. Visit . 24 | 2. Enter target repo. 25 | 3. Copy the "Link used by "Open in Gitpod" button:" URL 26 | 4. Replace `https://github.com/ddev/ddev-gitpod-launcher/` with the branch path Eg. `https://github.com/tyler36/ddev-gitpod-launcher/tree/wip-branch` 27 | 28 | ### Gitpod Validation 29 | 30 | This technique involves spawning debug workspaces. 31 | 32 | 1. Visit 33 | 2. Enter target repo. 34 | 3. Click "open in repo". 35 | 4. Make required changes. 36 | 5. In the terminal, type `gp validate`. 37 | 38 | This will spawn a new Gitpod workspace based on the current workspace. 39 | 40 | * All pre-builds, `init`, and `commands` are run in the new workspace as if were freshly created.. 41 | * Debugging output is shown in the original workspace. 42 | 43 | To end the session, press Ctrl+c, or Command+c, in the original window. This will terminate the debug workspace and while maintaining the original workspace. 44 | -------------------------------------------------------------------------------- /docs/_config.yml: -------------------------------------------------------------------------------- 1 | theme: jekyll-theme-time-machine -------------------------------------------------------------------------------- /docs/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | ddev-gitpod-launcher form 8 | 9 | 10 | 11 | 12 | 13 |
14 | 15 |

ddev Gitpod launcher

16 | 17 |

Launch and develop any web project in gitpod using DDEV!

18 | 19 |
20 |
21 | 22 | 23 | 24 | 25 | Open in Gitpod 26 |
27 |
28 | 29 | Your project (in any reachable GitHub, GitLab, or Bitbucket repository) will be opened in Gitpod.io. 30 | If a companion artifacts repository exists, database and files will be loaded. 31 | Read the docs. 32 | 33 |

34 |
Link used by "Open in Gitpod" button:
35 |
36 | 37 | 38 | 44 | 45 | 46 | 47 | 48 | -------------------------------------------------------------------------------- /docs/script.js: -------------------------------------------------------------------------------- 1 | // Function to compute and update the URL based on form inputs 2 | const computeLink = () => { 3 | // Initialize an object to store the form values 4 | let values = {}; 5 | // Get the form element with id 'target' 6 | const targetElement = document.getElementById('target'); 7 | // If the target element exists, iterate over its children with a 'name' attribute 8 | if (targetElement) { 9 | targetElement.querySelectorAll('[name]').forEach((element) => { 10 | // Store each element's value in the values object using its name attribute as the key 11 | values[element.getAttribute('name')] = element.value; 12 | }); 13 | } 14 | 15 | // Start building the URL string with the base Gitpod URL and autostart parameter 16 | let urlString = 'https://gitpod.io/?autostart=true#'; 17 | // Extract the keys from the values object 18 | const keys = Object.keys(values); 19 | // Append each key-value pair to the URL string, URL-encoded and separated by commas 20 | keys.forEach((key, i) => { 21 | urlString += (i > 0 ? ',' : '') + encodeURIComponent(key) + '=' + encodeURIComponent(values[key]); 22 | }); 23 | 24 | // Extract the owner from the current window's hostname 25 | const owner = window.location.host.split('.')[0]; 26 | // Construct the base repository URL using the owner and the current pathname 27 | const baseRepo = `https://github.com/${owner}${window.location.pathname}`; 28 | // Append the base repository URL to the urlString 29 | urlString += '/' + baseRepo; 30 | 31 | // Get the elements where the computed URL will be displayed 32 | const computedUrlElement = document.getElementById('computedUrl'); 33 | const ddevLinkElement = document.getElementById('ddev-link'); 34 | // If both elements exist, set the href attribute and text content to the computed URL 35 | if (computedUrlElement && ddevLinkElement) { 36 | computedUrlElement.setAttribute('href', urlString); 37 | ddevLinkElement.textContent = urlString; // Use textContent for security and performance 38 | } 39 | }; 40 | 41 | // Call the computeLink function to initialize the URL link on page load 42 | computeLink(); 43 | 44 | // Add input event listeners to all form elements with a 'name' attribute within the element with id 'target' 45 | const targetElement = document.getElementById('target'); 46 | // If the target element exists, attach the computeLink function as an event listener for the 'input' event 47 | if (targetElement) { 48 | targetElement.querySelectorAll('[name]').forEach((element) => { 49 | element.addEventListener('input', computeLink); 50 | }); 51 | } 52 | 53 | // Add input event listener to the repository field to update artifacts when it changes 54 | const repoElement = document.getElementById('ddev-repo'); 55 | // If the repository element exists, attach the updateArtifacts function as an event listener for the 'input' event 56 | if (repoElement) { 57 | repoElement.addEventListener('input', updateArtifacts); 58 | } -------------------------------------------------------------------------------- /docs/style.css: -------------------------------------------------------------------------------- 1 | :root { 2 | --blue: #4223e5; 3 | --bg-body: #f5f4f4; 4 | --bg-button: #f9f9f9; 5 | --bg-footer: #e9e9e9; 6 | } 7 | 8 | 9 | * { 10 | box-sizing: border-box; 11 | } 12 | 13 | body { 14 | text-rendering: optimizeSpeed; 15 | background: var(--bg-body); 16 | color: #333; 17 | font-family: Arial, sans-serif; 18 | font-size: 100%; 19 | line-height: 1.5; 20 | } 21 | 22 | h1 { 23 | margin: 0; 24 | } 25 | 26 | h4 { 27 | margin: 0; 28 | } 29 | 30 | .wrapper { 31 | max-width: 600px; 32 | margin: 60px auto; 33 | padding-bottom: 200px; 34 | box-shadow: 0 0 4px #ddd; 35 | padding: 40px; 36 | border-radius: 20px; 37 | } 38 | 39 | #target { 40 | margin-top: 60px; 41 | } 42 | 43 | input { 44 | display: block; 45 | padding: 10px; 46 | width: 100%; 47 | margin: 5px 0 20px 0; 48 | } 49 | 50 | .button { 51 | display: inline-block; 52 | margin: 20px 0; 53 | border-radius: 20px; 54 | cursor: pointer; 55 | transition: all .2s; 56 | background: url(https://www.gitpod.io/svg/media-kit/logo-mark.svg) no-repeat 10px center var(--bg-button); 57 | background-size: 25px; 58 | font-weight: bold; 59 | text-align: center; 60 | font-size: 0.9rem; 61 | padding: 15px 20px 15px 45px; 62 | text-decoration: none; 63 | box-shadow: 0 2px 3px 0 #ccc; 64 | color: #2e2d29; 65 | } 66 | 67 | .code { 68 | overflow-wrap: break-word; 69 | width: 100%; 70 | white-space: pre-wrap; 71 | background: #fff; 72 | padding: 10px; 73 | border: 1px solid #ddd; 74 | border-radius: 5px; 75 | font-size: 14px; 76 | } 77 | 78 | footer { 79 | position: fixed; 80 | bottom: 0; 81 | left: 0; 82 | width: 100%; 83 | background: var(--bg-footer); 84 | } 85 | 86 | footer p { 87 | margin: 0 0 0.5em 0; 88 | } 89 | 90 | footer a { 91 | text-decoration: none; 92 | color: var(--blue); 93 | } 94 | 95 | .footer { 96 | text-align: center; 97 | margin: 20px; 98 | font-size: 0.9rem; 99 | } -------------------------------------------------------------------------------- /repo.code-workspace: -------------------------------------------------------------------------------- 1 | { 2 | // All paths are relative to your main repo 3 | // The additional repos are cloned inside /workspace dir 4 | "folders": [ 5 | { 6 | "path": "../code" // Additional repo 7 | } 8 | ] 9 | } 10 | --------------------------------------------------------------------------------