Browse Source

Run update.sh

Docker Library Bot 9 years ago
parent
commit
ceeca17103
2 changed files with 29 additions and 6 deletions
  1. 25 2
      elixir/README.md
  2. 4 4
      erlang/README.md

+ 25 - 2
elixir/README.md

@@ -1,9 +1,12 @@
 # Supported tags and respective `Dockerfile` links
 
--	[`1.2.4`, `1.2`, `latest` (*1.2/Dockerfile*)](https://github.com/c0b/docker-elixir/blob/8a1bf2bebcf4488408fc5e9f51c6ef09e0abbee6/1.2/Dockerfile)
+-	[`1.2.5`, `1.2`, `latest` (*1.2/Dockerfile*)](https://github.com/c0b/docker-elixir/blob/22ee98417200ef8d9a049b2b4504e7cf279e911f/1.2/Dockerfile)
+-	[`1.2-slim`, `slim` (*1.2/slim/Dockerfile*)](https://github.com/c0b/docker-elixir/blob/22ee98417200ef8d9a049b2b4504e7cf279e911f/1.2/slim/Dockerfile)
+-	[`1.2-onbuild`, `onbuild` (*1.2/onbuild/Dockerfile*)](https://github.com/c0b/docker-elixir/blob/22ee98417200ef8d9a049b2b4504e7cf279e911f/1.2/onbuild/Dockerfile)
+-	[`1.2.4` (*1.2/Dockerfile*)](https://github.com/c0b/docker-elixir/blob/8a1bf2bebcf4488408fc5e9f51c6ef09e0abbee6/1.2/Dockerfile)
 -	[`1.2.3` (*1.2/Dockerfile*)](https://github.com/c0b/docker-elixir/blob/08b645312bcbf020214e36679eec248234485b3a/1.2/Dockerfile)
 
-[![](https://badge.imagelayers.io/elixir:latest.svg)](https://imagelayers.io/?images=elixir:1.2.4,elixir:1.2.3)
+[![](https://badge.imagelayers.io/elixir:latest.svg)](https://imagelayers.io/?images=elixir:1.2.5,elixir:1.2-slim,elixir:1.2-onbuild,elixir:1.2.4,elixir:1.2.3)
 
 For more information about this image and its history, please see [the relevant manifest file (`library/elixir`)](https://github.com/docker-library/official-images/blob/master/library/elixir). This image is updated via [pull requests to the `docker-library/official-images` GitHub repo](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2Felixir).
 
@@ -48,6 +51,26 @@ iex(snode@elixir)2> :c.uptime
 $ docker run -it --rm --name elixir-inst1 -v "$PWD":/usr/src/myapp -w /usr/src/myapp elixir elixir your-escript.exs
 ```
 
+# Image Variants
+
+The `elixir` images come in many flavors, each designed for a specific use case.
+
+## `elixir:<version>`
+
+This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
+
+## `elixir:onbuild`
+
+This image makes building derivative images easier. For most use cases, creating a `Dockerfile` in the base of your project directory with the line `FROM elixir:onbuild` will be enough to create a stand-alone image for your project.
+
+While the `onbuild` variant is really useful for "getting off the ground running" (zero to Dockerized in a short period of time), it's not recommended for long-term usage within a project due to the lack of control over *when* the `ONBUILD` triggers fire (see also [`docker/docker#5714`](https://github.com/docker/docker/issues/5714), [`docker/docker#8240`](https://github.com/docker/docker/issues/8240), [`docker/docker#11917`](https://github.com/docker/docker/issues/11917)).
+
+Once you've got a handle on how your project functions within Docker, you'll probably want to adjust your `Dockerfile` to inherit from a non-`onbuild` variant and copy the commands from the `onbuild` variant `Dockerfile` (moving the `ONBUILD` lines to the end and removing the `ONBUILD` keywords) into your own file so that you have tighter control over them and more transparency for yourself and others looking at your `Dockerfile` as to what it does. This also makes it easier to add additional requirements as time goes on (such as installing more packages before performing the previously-`ONBUILD` steps).
+
+## `elixir:slim`
+
+This image does not contain the common packages contained in the default tag and only contains the minimal packages needed to run `elixir`. Unless you are working in an environment where *only* the elixir image will be deployed and you have space constraints, we highly recommend using the default image of this repository.
+
 # License
 
 Copyright 2012 Plataformatec

+ 4 - 4
erlang/README.md

@@ -1,12 +1,12 @@
 # Supported tags and respective `Dockerfile` links
 
--	[`18.3.2`, `18.3`, `18`, `latest` (*18/Dockerfile*)](https://github.com/c0b/docker-erlang-otp/blob/a9f5121f34deb30cc61e21f0370aa8f16723aa14/18/Dockerfile)
--	[`18.3-slim`, `18-slim`, `slim` (*18/slim/Dockerfile*)](https://github.com/c0b/docker-erlang-otp/blob/a9f5121f34deb30cc61e21f0370aa8f16723aa14/18/slim/Dockerfile)
--	[`18.3-onbuild`, `18-onbuild`, `onbuild` (*18/onbuild/Dockerfile*)](https://github.com/c0b/docker-erlang-otp/blob/a9f5121f34deb30cc61e21f0370aa8f16723aa14/18/onbuild/Dockerfile)
+-	[`18.3.3`, `18.3`, `18`, `latest` (*18/Dockerfile*)](https://github.com/c0b/docker-erlang-otp/blob/2daeab9ef204095169b3cc96def31ce08a5f7358/18/Dockerfile)
+-	[`18.3-slim`, `18-slim`, `slim` (*18/slim/Dockerfile*)](https://github.com/c0b/docker-erlang-otp/blob/2daeab9ef204095169b3cc96def31ce08a5f7358/18/slim/Dockerfile)
+-	[`18.3-onbuild`, `18-onbuild`, `onbuild` (*18/onbuild/Dockerfile*)](https://github.com/c0b/docker-erlang-otp/blob/2daeab9ef204095169b3cc96def31ce08a5f7358/18/onbuild/Dockerfile)
 -	[`17.5.6.8`, `17.5`, `17` (*17/Dockerfile*)](https://github.com/c0b/docker-erlang-otp/blob/7b450cd7f43203d34c10ae0d35e9f8ea67257415/17/Dockerfile)
 -	[`17.5-slim`, `17-slim` (*17/slim/Dockerfile*)](https://github.com/c0b/docker-erlang-otp/blob/7b450cd7f43203d34c10ae0d35e9f8ea67257415/17/slim/Dockerfile)
 
-[![](https://badge.imagelayers.io/erlang:latest.svg)](https://imagelayers.io/?images=erlang:18.3.2,erlang:18.3-slim,erlang:18.3-onbuild,erlang:17.5.6.8,erlang:17.5-slim)
+[![](https://badge.imagelayers.io/erlang:latest.svg)](https://imagelayers.io/?images=erlang:18.3.3,erlang:18.3-slim,erlang:18.3-onbuild,erlang:17.5.6.8,erlang:17.5-slim)
 
 For more information about this image and its history, please see [the relevant manifest file (`library/erlang`)](https://github.com/docker-library/official-images/blob/master/library/erlang). This image is updated via [pull requests to the `docker-library/official-images` GitHub repo](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2Ferlang).