Skip to content

Commit 99aba5c

Browse files
greyscaledgreyscaled
authored
docs: Add image READMEs (#28)
1 parent 749f3e6 commit 99aba5c

File tree

12 files changed

+147
-9
lines changed

12 files changed

+147
-9
lines changed

‎README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ about supported editors and known issues.
1414
All of the images provided in this repo include the following utilities to ensure they work well
1515
with all of Coder Enterprise's features, and to provide a solid out-of-the-box developer experience:
1616

17-
* git
18-
* bash
19-
* curl & wget
20-
* htop
21-
* man
22-
* vim
23-
* sudo
24-
* python3 & pip3
25-
* gcc & gcc-c++ & make
17+
- git
18+
- bash
19+
- curl & wget
20+
- htop
21+
- man
22+
- vim
23+
- sudo
24+
- python3 & pip3
25+
- gcc & gcc-c++ & make
2626

2727
## Images on Docker Hub
2828

‎images/base/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Enterprise Base
2+
3+
[![Docker Pulls](https://img.shields.io/docker/pulls/codercom/enterprise-base?label=codercom%2Fenterprise-base)](https://hub.docker.com/r/codercom/enterprise-base)
4+
5+
## Description
6+
7+
Base images from which all other images in this repository extend from.
8+
9+
## How To Use It
10+
11+
Extend this image with additional tooling and language packages.

‎images/configure/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Coder Configure
2+
3+
## Description
4+
5+
This directory contains an example [image](./Dockerfile.ubuntu) and [configure](./configure)
6+
script. The configure script is used to add [`nvm`](https://github.com/nvm-sh/nvm) to a Coder environment.
7+
8+
## How To Use It
9+
10+
If an image contains an executable script located at `/coder/configure`, it is
11+
automatically detected and executed by Coder environments during the build
12+
process.
13+
14+
## Further Reading
15+
16+
Our support site contains [a tutorial](https://help.coder.com/hc/en-us/articles/360055782794-Configuring-Your-Environment-on-Startup) on Coder Configure.

‎images/goland/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Enterprise GoLand
2+
3+
[![Docker Pulls](https://img.shields.io/docker/pulls/codercom/enterprise-goland?label=codercom%2Fenterprise-goland)](https://hub.docker.com/r/codercom/enterprise-goland)
4+
5+
## Description
6+
7+
Wraps [enterprise-multieditor](../multieditor/README.md) with GoLand installation.
8+
9+
## How To Use It
10+
11+
This image is ready for direct use within Coder Enterprise. Environments
12+
created from this image will be able to launch GoLand.

‎images/golang/README.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Enterprise Golang
2+
3+
[![DockerPulls](https://img.shields.io/docker/pulls/codercom/enterprise-golang)](https://hub.docker.com/r/codercom/enterprise-golang)
4+
5+
## Description
6+
7+
Wraps [enterprise-base](../base/README.md) with the basics for Go development.
8+
9+
> **Note:** This image does not contain GoLand. For an example of how to install
10+
> GoLand, see [enterprise-goland](../goland/README.md)
11+
12+
## How To Use
13+
14+
This image is ready for direct use within Coder Enterprise.

‎images/intellij/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Enterprise IntelliJ
2+
3+
[![Docker Pulls](https://img.shields.io/docker/pulls/codercom/enterprise-intellij?label=codercom%2Fenterprise-intellij)](https://hub.docker.com/r/codercom/enterprise-intellij)
4+
5+
## Description
6+
7+
Wraps [enterprise-multieditor](../multieditor/README.md) with IntelliJ installation.
8+
9+
## How To Use It
10+
11+
This image is ready for direct use within Coder Enterprise. Environments
12+
created from this image will be able to launch IntelliJ IDEA.

‎images/java/README.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Enterprise Java
2+
3+
[![Docker Pulls](https://img.shields.io/docker/pulls/codercom/enterprise-java?label=codercom%2Fenterprise-java)](https://hub.docker.com/r/codercom/enterprise-java)
4+
5+
## Description
6+
7+
Wraps [enterprise-base](../base/README.md) with the basics for Java development.
8+
9+
> **Note:** This image does not contain IntelliJ. For an example of how to install
10+
> IntelliJ, see [enterprise-intellij](../intellij/README.md)
11+
12+
## How To Use
13+
14+
This image is ready for direct use within Coder Enterprise.

‎images/jupyter/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Enterprise Jupyter
2+
3+
[![Docker Pulls](https://img.shields.io/docker/pulls/codercom/enterprise-jupyter?label=codercom%2Fenterprise-jupyter)](https://hub.docker.com/r/codercom/enterprise-jupyter)
4+
5+
## Description
6+
7+
Wraps [enterprise-base](../base/README.md) with Jupyter installation.
8+
9+
## How To Use It
10+
11+
This image is ready for direct use within Coder Enterprise. Environments
12+
created from this image will be able to launch Jupyter.

‎images/multieditor/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Enterprise Multi Editor
2+
3+
[![Docker Pulls](https://img.shields.io/docker/pulls/codercom/enterprise-multieditor?label=codercom%2Fenterprise-multieditor)](https://hub.docker.com/r/codercom/enterprise-multieditor)
4+
5+
## Description
6+
7+
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.
8+
9+
## How To Use It
10+
11+
This image should be extended with the installation of an IDE. For example, see
12+
our [enterprise-goland:ubuntu](../goland/Dockerfile.ubuntu).

‎images/node/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Enterprise Node
2+
3+
[![Docker Pulls](https://img.shields.io/docker/pulls/codercom/enterprise-node?label=codercom%2Fenterprise-node)](https://hub.docker.com/r/codercom/enterprise-node)
4+
5+
## Description
6+
7+
Wraps [enterprise-base](../base/README.md) with the basics for Node development.
8+
9+
## How To Use
10+
11+
This image is ready for direct use within Coder Enterprise.

‎images/pycharm/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Enterprise PyCharm
2+
3+
[![Docker Pulls](https://img.shields.io/docker/pulls/codercom/enterprise-pycharm?label=codercom%2Fenterprise-pycharm)](https://hub.docker.com/r/codercom/enterprise-pycharm)
4+
5+
## Description
6+
7+
Wraps [enterprise-multieditor](../multieditor/README.md) with PyCharm installation.
8+
9+
## How To Use It
10+
11+
This image is ready for direct use within Coder Enterprise. Environments
12+
created from this image will be able to launch PyCharm.

‎images/webstorm/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Enterprise WebStorm
2+
3+
[![Docker Pulls](https://img.shields.io/docker/pulls/codercom/enterprise-webstorm?label=codercom%2Fenterprise-webstorm)](https://hub.docker.com/r/codercom/enterprise-webstorm)
4+
5+
## Description
6+
7+
Wraps [enterprise-multieditor](../multieditor/README.md) with WebStorm installation.
8+
9+
## How To Use It
10+
11+
This image is ready for direct use within Coder Enterprise. Environments
12+
created from this image will be able to launch WebStorm.

0 commit comments

Comments
 (0)