Skip to content

Commit ab86184

Browse files
authored
docs: document unsupported features (#219)
1 parent 9a854fc commit ab86184

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

+19
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,25 @@ docker run -it --rm \
285285
- [`ENVBUILDER_SSL_CERT_DIR`](https://go.dev/src/crypto/x509/root_unix.go#L25): Identifies which directory to check for SSL certificate files.
286286
- `ENVBUILDER_SSL_CERT_BASE64`: Specifies a base64-encoded SSL certificate that will be added to the global certificate pool on start.
287287

288+
## Unsupported features
289+
290+
### Development Containers
291+
292+
The table keeps track of features we would love to implement. Feel free to [create a new issue](https://github.com/coder/envbuilder/issues/new) if you want Envbuilder to support it.
293+
294+
| Name | Description | Known issues |
295+
| ------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ |
296+
| Volume mounts | Volumes are used to persist data and share directories between the host and container. | [#220](https://github.com/coder/envbuilder/issues/220) |
297+
| Port forwarding | Port forwarding allows exposing container ports to the host, making services accessible. | [#48](https://github.com/coder/envbuilder/issues/48) |
298+
| Script init & Entrypoint | `init` adds a tiny init process to the container and `entrypoint` sets a script to run at container startup. | [#221](https://github.com/coder/envbuilder/issues/221) |
299+
| Customizations | Product specific properties, for instance: _VS Code_ `settings` and `extensions`. | [#43](https://github.com/coder/envbuilder/issues/43) |
300+
301+
### Devfile
302+
303+
> [Devfiles](https://devfile.io/) automate and simplify development process by adopting the existing devfiles that are available in the [public community registry](https://registry.devfile.io/viewer).
304+
305+
Issue: [#113](https://github.com/coder/envbuilder/issues/113)
306+
288307
# Local Development
289308

290309
Building `envbuilder` currently **requires** a Linux system.

0 commit comments

Comments
 (0)