Update image docs
authorRafael dos Santos Silva <xfalcox@gmail.com>
Fri, 17 Aug 2018 20:06:58 +0000 (17:06 -0300)
committerRafael dos Santos Silva <xfalcox@gmail.com>
Fri, 17 Aug 2018 20:06:58 +0000 (17:06 -0300)
image/README.md

index 22a34170d0eea04ab6a892b24f184005178e076f..007f1f37ebc5c66aacfd9c6cab538ea57646947f 100644 (file)
@@ -2,21 +2,16 @@
 
 ## Building new images
 
-To build a new set of images, update the `Makefile` with the new version number, and then `make all`.  This will automatically update the header comments in the Dockerfiles and update any `FROM` statements to ensure that the image verions remain in lock-step with each other.  (The downside is that if you only wanted to tweak a "leaf" image, you'll still be touching/updating _all_ of the images.  But reasoning about the images is much easier if they all have the same version.)
+To build a new image, just run `ruby auto_build.rb image-name`. The build process will build a local image with a predefined tag.
 
-The build process will tag the images with the version number, but not with "latest", nor will it push the images up to Docker Hub.  Both of those steps must be performed manually.
-
-> _A note about docker-squash:_ Getting docker-squash configured correctly on OSX takes a bit of doing, so if you want to simply skip the squashing step entirely, just prefix the make command with `SQUASH=NO`, as follows:
->
-> ```sh
-> SQUASH=NO make all
-> ```
+Images and tag names are defined [here](https://github.com/discourse/discourse_docker/blob/master/image/auto_build.rb#L6-L11).
 
+> **A note about --squash**: By default we squash the images we serve on Docker Hub. You will need to [enable experimental features](https://github.com/docker/docker-ce/blob/master/components/cli/experimental/README.md) on your Docker daemon for that.
 
 
 ## More about the images
 
-See both `Makefile` and the respective `Dockerfile`s for details on _how_ all of this happens.
+See both `auto_build.rb` and the respective `Dockerfile`s for details on _how_ all of this happens.
 
 
 ### base ([discourse/base](https://hub.docker.com/r/discourse/base/))
@@ -24,11 +19,6 @@ See both `Makefile` and the respective `Dockerfile`s for details on _how_ all of
 All of the dependencies for running Discourse.  This includes runit, postgres, nginx, ruby, imagemagick, etc.  It also includes the creation of the "discourse" user and `/var/www` directory.
 
 
-### discourse ([discourse/discourse](https://hub.docker.com/r/discourse/discourse/))
-
-Builds on the base image and adds the current (as of image build time) version of Discourse, cloned from GitHub, and also the bundled gems.
-
-
 ### discourse_dev ([discourse/discourse_dev](https://hub.docker.com/r/discourse/discourse_dev/))
 
 Adds redis and postgres just like the "standalone" template for Discourse in order to have an all-in-one container for development.  Note that you are expected to mount your local discourse source directory to `/src`.  See [the README in GitHub's discourse/bin/docker](https://github.com/discourse/discourse/tree/master/bin/docker/) for utilities that help with this.