Skip to content

Automated documentation update #430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
devcontainers-repos-automation wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Automated documentation update #430

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/alpine/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Simple Alpine container with Git installed.

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| imageVariant | Alpine version: | string | 3.22 |
| imageVariant | Alpine version: | string | 3.23 |

This template references an image that was [pre-built](https://containers.dev/implementors/reference/#prebuilding) to automatically include needed devcontainer.json metadata.

Expand Down
4 changes: 2 additions & 2 deletions src/cpp-mariadb/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@

# C++ & MariaDB (cpp-mariadb)
# cpp-mariadb

Develop C++ applications on Linux. Includes Debian C++ build tools.

## Options

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| imageVariant | Debian / Ubuntu version (use Debian 12, Debian 11, Ubuntu 24.04, and Ubuntu 22.04 on local arm64/Apple Silicon): | string | debian12 |
| imageVariant | Debian / Ubuntu version (use Debian 13, Debian 12, Ubuntu 24.04, and Ubuntu 22.04 on local arm64/Apple Silicon): | string | debian13 |
| reinstallCmakeVersionFromSource | Install CMake version different from what base image has already installed. | string | none |

This template references an image that was [pre-built](https://containers.dev/implementors/reference/#prebuilding) to automatically include needed devcontainer.json metadata.
Expand Down
4 changes: 2 additions & 2 deletions src/cpp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@

# C++ (cpp)
# cpp

Develop C++ applications on Linux. Includes Debian C++ build tools.

## Options

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| imageVariant | Debian / Ubuntu version (use debian12, debian11, ubuntu24.04, and ubuntu22.04 on local arm64/Apple Silicon): | string | debian12 |
| imageVariant | Debian / Ubuntu version (use Debian 13, Debian 12, Ubuntu 24.04, and Ubuntu 22.04 on local arm64/Apple Silicon): | string | debian13 |
| reinstallCmakeVersionFromSource | Install CMake version different from what base image has already installed. | string | none |

This template references an image that was [pre-built](https://containers.dev/implementors/reference/#prebuilding) to automatically include needed devcontainer.json metadata.
Expand Down
1 change: 1 addition & 0 deletions src/debian/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ This template references an image that was [pre-built](https://containers.dev/im
* **Image**: mcr.microsoft.com/devcontainers/base:debian ([source](https://github.com/devcontainers/images/tree/main/src/base-debian))
* **Applies devcontainer.json contents from image**: Yes ([source](https://github.com/devcontainers/images/blob/main/src/base-debian/.devcontainer/devcontainer.json))


---

_Note: This file was auto-generated from the [devcontainer-template.json](https://github.com/devcontainers/templates/blob/main/src/debian/devcontainer-template.json). Add additional notes to a `NOTES.md`._
2 changes: 1 addition & 1 deletion src/docker-existing-dockerfile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Existing Dockerfile (docker-existing-dockerfile)

Sample illustrating reuse of an existing Dockefile.
Sample illustrating reuse of an existing Dockerfile.



Expand Down
11 changes: 3 additions & 8 deletions src/java-postgres/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Develop applications with Java and PostgreSQL. Includes a Java application conta

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| imageVariant | Java version (use -bookworm, or -bullseye variants on local arm64/Apple Silicon): | string | 21-bullseye |
| imageVariant | Java version (use -trixie, or -bookworm variants on local arm64/Apple Silicon): | string | 25-trixie |
| installMaven | Install Maven, a management tool for Java | boolean | false |
| installGradle | Install Gradle, a build automation tool for multi-language software development | boolean | false |

Expand All @@ -18,7 +18,7 @@ This template references an image that was [pre-built](https://containers.dev/im

## Using this template

This template creates two containers, one for Java and one for PostgreSQL. You will be connected to the Java container, and from within that container the PostgreSQL container will be available on **`localhost`** port 5432. The default database is named `postgres` with a user of `postgres` whose password is `postgres`, and if desired this may be changed in `.devcontainer/docker-compose.yml`. Data is stored in a volume named `postgres-data`.
This template creates two containers, one for Java and one for PostgreSQL. You will be connected to the Java container, and from within that container the PostgreSQL container will be available on the hostname **`db`** port 5432. The default database is named `postgres` with a user of `postgres` whose password is `postgres`, and if desired this may be changed in `.devcontainer/docker-compose.yml`. Data is stored in a volume named `postgres-data`.

While the template itself works unmodified, it uses the `mcr.microsoft.com/devcontainers/java` image which includes `git`, a non-root `vscode` user with `sudo` access, and a set of common dependencies and Java tools for development.

Expand All @@ -41,12 +41,7 @@ If needed, you can use `postCreateCommand` to run commands after the container i

### Adding another service

You can add other services to your `.devcontainer/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 database container, allows "forwardPorts" in devcontainer.json function.
network_mode: service:db
```
You can add other services to your `.devcontainer/docker-compose.yml` file [as described in Docker's documentation](https://docs.docker.com/compose/compose-file/#service-configuration-reference). For inter-service communication, attach new services to the `app-network` bridge network configured in the compose file.

### Using the forwardPorts property

Expand Down
2 changes: 1 addition & 1 deletion src/java/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Develop Java applications. Includes the JDK and Java extensions.

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| imageVariant | Java version (use -bookworm, or -bullseye variants on local arm64/Apple Silicon): | string | 21-bullseye |
| imageVariant | Java version (use -trixie, or -bookworm variants on local arm64/Apple Silicon): | string | 25-trixie |
| installMaven | Install Maven, a management tool for Java | boolean | false |
| installGradle | Install Gradle, a build automation tool for multi-language software development | boolean | false |

Expand Down
2 changes: 1 addition & 1 deletion src/javascript-node-mongo/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Develop applications in Node.js and Mongo DB. Includes Node.js, eslint, and yarn

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| imageVariant | Node.js version (use -bullseye variants on local arm64/Apple Silicon): | string | 22-bookworm |
| imageVariant | Node.js version (use -bookworm or -bullseye variants on local arm64/Apple Silicon): | string | 24-bookworm |

This template references an image that was [pre-built](https://containers.dev/implementors/reference/#prebuilding) to automatically include needed devcontainer.json metadata.

Expand Down
4 changes: 2 additions & 2 deletions src/javascript-node-postgres/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Develop applications in Node.js and PostgreSQL. Includes Node.js, eslint, and ya

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| imageVariant | Node.js version (use -bookworm, -bullseye variants on local arm64/Apple Silicon): | string | 22-bookworm |
| imageVariant | Node.js version (use -trixie, -bookworm, or -bullseye variants on local arm64/Apple Silicon): | string | 24-trixie |

This template references an image that was [pre-built](https://containers.dev/implementors/reference/#prebuilding) to automatically include needed devcontainer.json metadata.

Expand All @@ -16,7 +16,7 @@ This template references an image that was [pre-built](https://containers.dev/im

## Using this template

This definition creates two containers, one for Node.js and one for PostgreSQL. You will be connected to the Node.js container, and from within that container the PostgreSQL container will be available on **`localhost`** port 5432. The default database is named `postgres` with a user of `postgres` whose password is `postgres`, and if desired this may be changed in `docker-compose.yml`. Data is stored in a volume named `postgres-data`.
This definition creates two containers, one for Node.js and one for PostgreSQL. You will be connected to the Node.js container, and from within that container the PostgreSQL container will be available on **`db`** port 5432. The default database is named `postgres` with a user of `postgres` whose password is `postgres`, and if desired this may be changed in `docker-compose.yml`. Data is stored in a volume named `postgres-data`.

While the definition itself works unmodified, it uses the `mcr.microsoft.com/devcontainers/javascript-node` image which includes `git`, `eslint`, `zsh`, [Oh My Zsh!](https://ohmyz.sh/), a non-root `vscode` user with `sudo` access, and a set of common dependencies for development.

Expand Down
2 changes: 1 addition & 1 deletion src/javascript-node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Develop Node.js based applications. Includes Node.js, eslint, nvm, and yarn.

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| imageVariant | Node.js version (use -bookworm, -bullseye variants on local arm64/Apple Silicon): | string | 22-bookworm |
| imageVariant | Node.js version (use -trixie, -bookworm, or -bullseye variants on local arm64/Apple Silicon): | string | 24-trixie |

This template references an image that was [pre-built](https://containers.dev/implementors/reference/#prebuilding) to automatically include needed devcontainer.json metadata.

Expand Down
2 changes: 1 addition & 1 deletion src/php-mariadb/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Develop PHP applications with MariaDB (MySQL Compatible).

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| imageVariant | PHP version (use -bookworm, -bullseye variants on local arm64/Apple Silicon): | string | 8.5-trixie |
| imageVariant | PHP version (use -trixie, -bookworm, -bullseye variants on local arm64/Apple Silicon): | string | 8.5-trixie |

This template references an image that was [pre-built](https://containers.dev/implementors/reference/#prebuilding) to automatically include needed devcontainer.json metadata.

Expand Down
2 changes: 1 addition & 1 deletion src/php/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Develop PHP based applications. Includes needed tools, extensions, and dependenc

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| imageVariant | PHP version (use -bookworm, -bullseye variants on local arm64/Apple Silicon): | string | 8.5-trixie|
| imageVariant | PHP version (use -trixie, -bookworm, -bullseye variants on local arm64/Apple Silicon): | string | 8.5-trixie |

This template references an image that was [pre-built](https://containers.dev/implementors/reference/#prebuilding) to automatically include needed devcontainer.json metadata.

Expand Down
2 changes: 1 addition & 1 deletion src/postgres/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Develop applications with Python 3 and PostgreSQL. Includes a Python application

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| imageVariant | Python version (use -bookworm, or -bullseye variants on local arm64/Apple Silicon): | string | 3.11-bullseye |
| imageVariant | Python version (use -trixie, -bookworm, or -bullseye variants on local arm64/Apple Silicon): | string | 3.14-trixie |

This template references an image that was [pre-built](https://containers.dev/implementors/reference/#prebuilding) to automatically include needed devcontainer.json metadata.

Expand Down
2 changes: 1 addition & 1 deletion src/python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Develop Python 3 applications.

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| imageVariant | Python version (use -trixie, -bookworm, or -bullseye variants on local arm64/Apple Silicon): | string | 3.13-trixie |
| imageVariant | Python version (use -trixie, or -bookworm variants on local arm64/Apple Silicon): | string | 3.14-trixie |

This template references an image that was [pre-built](https://containers.dev/implementors/reference/#prebuilding) to automatically include needed devcontainer.json metadata.

Expand Down
2 changes: 1 addition & 1 deletion src/ruby-rails-postgres/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Develop Ruby on Rails applications with Postgres. Includes a Rails application c

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| imageVariant | Ruby version (use -trixie, -bookworm, -bullseye variants on local arm64/Apple Silicon) : | string |4-trixie |
| imageVariant | Ruby version (use - trixie, -bookworm, -bullseye variants on local arm64/Apple Silicon): | string | 4-trixie |

This template references an image that was [pre-built](https://containers.dev/implementors/reference/#prebuilding) to automatically include needed devcontainer.json metadata.

Expand Down
2 changes: 1 addition & 1 deletion src/ruby/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Develop Ruby based applications. includes everything you need to get up and runn

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| imageVariant | Ruby version (use -trixie, -bookworm, -bullseye variants on local arm64/Apple Silicon) : | string |4-trixie |
| imageVariant | Ruby version (use -trixie, -bookworm, -bullseye variants on local arm64/Apple Silicon): | string | 4-trixie |

This template references an image that was [pre-built](https://containers.dev/implementors/reference/#prebuilding) to automatically include needed devcontainer.json metadata.

Expand Down
2 changes: 1 addition & 1 deletion src/rust-postgres/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Develop applications with Rust and PostgreSQL. Includes a Rust application conta

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| imageVariant | Debian OS version (use trixie, bookworm, or bullseye on local arm64/Apple Silicon): | string | trixie |
| imageVariant | Debian OS version (use bookworm, or bullseye on local arm64/Apple Silicon): | string | trixie |

This template references an image that was [pre-built](https://containers.dev/implementors/reference/#prebuilding) to automatically include needed devcontainer.json metadata.

Expand Down
2 changes: 1 addition & 1 deletion src/typescript-node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Develop Node.js based applications in TypeScript. Includes Node.js, eslint, nvm,

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| imageVariant | Node.js version (use -bookworm, -bullseye variants on local arm64/Apple Silicon): | string | 22-bookworm |
| imageVariant | Node.js version (use -trixie, -bookworm, or -bullseye variants on local arm64/Apple Silicon): | string | 24-trixie |

This template references an image that was [pre-built](https://containers.dev/implementors/reference/#prebuilding) to automatically include needed devcontainer.json metadata.

Expand Down
2 changes: 1 addition & 1 deletion src/ubuntu/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ A simple Ubuntu container with Git and other common utilities installed.

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| imageVariant | Ubuntu version (use ubuntu 26.04 or ubuntu24.04 or ubuntu22.04 on local arm64/Apple Silicon): | string | resolute | noble | jammy
| imageVariant | Ubuntu version (use ubuntu-26.04 or ubuntu-24.04 or ubuntu-22.04 on local arm64/Apple Silicon): | string | resolute |

This template references an image that was [pre-built](https://containers.dev/implementors/reference/#prebuilding) to automatically include needed devcontainer.json metadata.

Expand Down