Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kororo/test-devcontainer
https://github.com/kororo/test-devcontainer
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/kororo/test-devcontainer
- Owner: kororo
- Created: 2024-03-17T11:32:32.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-03-17T11:43:24.000Z (7 months ago)
- Last Synced: 2024-03-17T12:37:48.870Z (7 months ago)
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [Name of Definition Here] (Community)
## Summary
*[A short description of the the purpose of the definition goes here.]*
| Metadata | Value |
|---------------------------- | -----------------------------------------------------------------------------|
| *Contributors* | [Your name, GitHub profile] |
| *Categories* | Community, [Languages, Frameworks, Services, Azure, GCP, AWS, GitHub, Other] |
| *Definition type* | Docker Compose |
| *Works in Codespaces* | Yes / No |
| *Container host OS support* | Linux, macOS, Windows |
| *Container OS* | [OS used by container - e.g. Debian] |
| *Languages, platforms* | [Languages and platforms the container supports] |
## [Optional] Description
**[Give a more detailed description of the container if the summary does not provide enough info.]**
## Using this definition
**[Optional] Include any special setup requirements here. For example:**
While the definition itself works unmodified, you can select the version of **YOUR RUNTIME HERE** the container uses by updating the `VARIANT` arg in the included `.devcontainer/docker-compose.yml` file.
```yaml
args:
VARIANT: buster
```
### Adding another service
You can add other services to your `docker-compose.yml` file [as described in Docker's documentation](https://docs.docker.com/compose/compose-file/#service-configuration-reference). However, if you want anything running in this service to be available in the container on localhost, or want to forward the service locally, be sure to add this line to the service config:
```yaml
# Runs the service on the same network as the app container, allows "forwardPorts" in devcontainer.json function.
network_mode: service:app
```
### Adding the definition to a project or codespace
1. If this is your first time using a development container, please see getting started information on [setting up](https://aka.ms/vscode-remote/containers/getting-started) Remote-Containers or [creating a codespace](https://aka.ms/ghcs-open-codespace) using GitHub Codespaces.
2. Start VS Code and open your project folder or connect to a codespace.
3. Press F1 select and **Add Development Container Configuration Files...** command for **Remote-Containers** or **Codespaces**.
> **Note:** If needed, you can drag-and-drop the `.devcontainer` folder from this sub-folder in a locally cloned copy of this repository into the VS Code file explorer instead of using the command.
4. Select this definition. You may also need to select **Show All Definitions...** for it to appear.
5. Finally, press F1 and run **Remote-Containers: Reopen Folder in Container** or **Codespaces: Rebuild Container** to start using the definition.
## [Optional] Testing the definition
This definition includes some test code that will help you verify it is working as expected on your system. Follow these steps:
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
2. Clone this repository.
3. Start VS Code, press F1, and select **Remote-Containers: Open Folder in Container...**
4. Select this folder from the cloned repository.
5. **[Provide any information on steps required to test the definition.]**
## [Optional] How it works
**[If the definition provides a pattern you think will be useful for others, describe the it here.]**
## License
Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/main/LICENSE).