docs: Add image READMEs (#28)
This commit is contained in:
G r e y
GitHub
parent
749f3e6886
commit
99aba5c640
18
README.md
18
README.md
|
|
@ -14,15 +14,15 @@ about supported editors and known issues.
|
|||
All of the images provided in this repo include the following utilities to ensure they work well
|
||||
with all of Coder Enterprise's features, and to provide a solid out-of-the-box developer experience:
|
||||
|
||||
* git
|
||||
* bash
|
||||
* curl & wget
|
||||
* htop
|
||||
* man
|
||||
* vim
|
||||
* sudo
|
||||
* python3 & pip3
|
||||
* gcc & gcc-c++ & make
|
||||
- git
|
||||
- bash
|
||||
- curl & wget
|
||||
- htop
|
||||
- man
|
||||
- vim
|
||||
- sudo
|
||||
- python3 & pip3
|
||||
- gcc & gcc-c++ & make
|
||||
|
||||
## Images on Docker Hub
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,11 @@
|
|||
# Enterprise Base
|
||||
|
||||
[](https://hub.docker.com/r/codercom/enterprise-base)
|
||||
|
||||
## Description
|
||||
|
||||
Base images from which all other images in this repository extend from.
|
||||
|
||||
## How To Use It
|
||||
|
||||
Extend this image with additional tooling and language packages.
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
# Coder Configure
|
||||
|
||||
## Description
|
||||
|
||||
This directory contains an example [image](./Dockerfile.ubuntu) and [configure](./configure)
|
||||
script. The configure script is used to add [`nvm`](https://github.com/nvm-sh/nvm) to a Coder environment.
|
||||
|
||||
## How To Use It
|
||||
|
||||
If an image contains an executable script located at `/coder/configure`, it is
|
||||
automatically detected and executed by Coder environments during the build
|
||||
process.
|
||||
|
||||
## Further Reading
|
||||
|
||||
Our support site contains [a tutorial](https://help.coder.com/hc/en-us/articles/360055782794-Configuring-Your-Environment-on-Startup) on Coder Configure.
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
# Enterprise GoLand
|
||||
|
||||
[](https://hub.docker.com/r/codercom/enterprise-goland)
|
||||
|
||||
## Description
|
||||
|
||||
Wraps [enterprise-multieditor](../multieditor/README.md) with GoLand installation.
|
||||
|
||||
## How To Use It
|
||||
|
||||
This image is ready for direct use within Coder Enterprise. Environments
|
||||
created from this image will be able to launch GoLand.
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# Enterprise Golang
|
||||
|
||||
[](https://hub.docker.com/r/codercom/enterprise-golang)
|
||||
|
||||
## Description
|
||||
|
||||
Wraps [enterprise-base](../base/README.md) with the basics for Go development.
|
||||
|
||||
> **Note:** This image does not contain GoLand. For an example of how to install
|
||||
> GoLand, see [enterprise-goland](../goland/README.md)
|
||||
|
||||
## How To Use
|
||||
|
||||
This image is ready for direct use within Coder Enterprise.
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
# Enterprise IntelliJ
|
||||
|
||||
[](https://hub.docker.com/r/codercom/enterprise-intellij)
|
||||
|
||||
## Description
|
||||
|
||||
Wraps [enterprise-multieditor](../multieditor/README.md) with IntelliJ installation.
|
||||
|
||||
## How To Use It
|
||||
|
||||
This image is ready for direct use within Coder Enterprise. Environments
|
||||
created from this image will be able to launch IntelliJ IDEA.
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# Enterprise Java
|
||||
|
||||
[](https://hub.docker.com/r/codercom/enterprise-java)
|
||||
|
||||
## Description
|
||||
|
||||
Wraps [enterprise-base](../base/README.md) with the basics for Java development.
|
||||
|
||||
> **Note:** This image does not contain IntelliJ. For an example of how to install
|
||||
> IntelliJ, see [enterprise-intellij](../intellij/README.md)
|
||||
|
||||
## How To Use
|
||||
|
||||
This image is ready for direct use within Coder Enterprise.
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
# Enterprise Jupyter
|
||||
|
||||
[](https://hub.docker.com/r/codercom/enterprise-jupyter)
|
||||
|
||||
## Description
|
||||
|
||||
Wraps [enterprise-base](../base/README.md) with Jupyter installation.
|
||||
|
||||
## How To Use It
|
||||
|
||||
This image is ready for direct use within Coder Enterprise. Environments
|
||||
created from this image will be able to launch Jupyter.
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
# Enterprise Multi Editor
|
||||
|
||||
[](https://hub.docker.com/r/codercom/enterprise-multieditor)
|
||||
|
||||
## Description
|
||||
|
||||
By default, Coder Enterprise supports [`code-server`](https://github.com/cdr/code-server) and a terminal application. Additional IDEs [require dependencies](https://enterprise.coder.com/docs/installing-an-ide-onto-your-image#required-packages). This image builds on [enterprise-base](../base/README.md) image by adding those additional dependencies.
|
||||
|
||||
## How To Use It
|
||||
|
||||
This image should be extended with the installation of an IDE. For example, see
|
||||
our [enterprise-goland:ubuntu](../goland/Dockerfile.ubuntu).
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
# Enterprise Node
|
||||
|
||||
[](https://hub.docker.com/r/codercom/enterprise-node)
|
||||
|
||||
## Description
|
||||
|
||||
Wraps [enterprise-base](../base/README.md) with the basics for Node development.
|
||||
|
||||
## How To Use
|
||||
|
||||
This image is ready for direct use within Coder Enterprise.
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
# Enterprise PyCharm
|
||||
|
||||
[](https://hub.docker.com/r/codercom/enterprise-pycharm)
|
||||
|
||||
## Description
|
||||
|
||||
Wraps [enterprise-multieditor](../multieditor/README.md) with PyCharm installation.
|
||||
|
||||
## How To Use It
|
||||
|
||||
This image is ready for direct use within Coder Enterprise. Environments
|
||||
created from this image will be able to launch PyCharm.
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
# Enterprise WebStorm
|
||||
|
||||
[](https://hub.docker.com/r/codercom/enterprise-webstorm)
|
||||
|
||||
## Description
|
||||
|
||||
Wraps [enterprise-multieditor](../multieditor/README.md) with WebStorm installation.
|
||||
|
||||
## How To Use It
|
||||
|
||||
This image is ready for direct use within Coder Enterprise. Environments
|
||||
created from this image will be able to launch WebStorm.
|
||||
Loading…
Reference in New Issue