Skip to content

Add image-specific READMEs with dockerhub badges #28

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.

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

Merged
merged 1 commit into from
Dec 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
11 changes: 11 additions & 0 deletions images/base/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Enterprise Base

[![Docker Pulls](https://img.shields.io/docker/pulls/codercom/enterprise-base?label=codercom%2Fenterprise-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.
16 changes: 16 additions & 0 deletions images/configure/README.md
Original file line number Diff line number Diff line change
@@ -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.
12 changes: 12 additions & 0 deletions images/goland/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Enterprise GoLand

[![Docker Pulls](https://img.shields.io/docker/pulls/codercom/enterprise-goland?label=codercom%2Fenterprise-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.
14 changes: 14 additions & 0 deletions images/golang/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Enterprise Golang

[![DockerPulls](https://img.shields.io/docker/pulls/codercom/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.
12 changes: 12 additions & 0 deletions images/intellij/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Enterprise IntelliJ

[![Docker Pulls](https://img.shields.io/docker/pulls/codercom/enterprise-intellij?label=codercom%2Fenterprise-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.
14 changes: 14 additions & 0 deletions images/java/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Enterprise Java

[![Docker Pulls](https://img.shields.io/docker/pulls/codercom/enterprise-java?label=codercom%2Fenterprise-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.
12 changes: 12 additions & 0 deletions images/jupyter/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Enterprise Jupyter

[![Docker Pulls](https://img.shields.io/docker/pulls/codercom/enterprise-jupyter?label=codercom%2Fenterprise-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.
12 changes: 12 additions & 0 deletions images/multieditor/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Enterprise Multi Editor

[![Docker Pulls](https://img.shields.io/docker/pulls/codercom/enterprise-multieditor?label=codercom%2Fenterprise-multieditor)](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).
11 changes: 11 additions & 0 deletions images/node/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Enterprise Node

[![Docker Pulls](https://img.shields.io/docker/pulls/codercom/enterprise-node?label=codercom%2Fenterprise-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.
12 changes: 12 additions & 0 deletions images/pycharm/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Enterprise PyCharm

[![Docker Pulls](https://img.shields.io/docker/pulls/codercom/enterprise-pycharm?label=codercom%2Fenterprise-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.
12 changes: 12 additions & 0 deletions images/webstorm/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Enterprise WebStorm

[![Docker Pulls](https://img.shields.io/docker/pulls/codercom/enterprise-webstorm?label=codercom%2Fenterprise-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.