Skip to content

Latest commit

 

History

History
 
 

clojure

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README-short.txt
README-short.txt
 
 
README.md
README.md
 
 
content.md
content.md
 
 
github-repo
github-repo
 
 
license.md
license.md
 
 
logo.png
logo.png
 
 
maintainer.md
maintainer.md
 
 

README.md

Quick reference

Supported tags and respective Dockerfile links

Quick reference (cont.)

What is Clojure?

Clojure is a dialect of the Lisp programming language. It is a general-purpose programming language with an emphasis on functional programming. It runs on the Java Virtual Machine, Common Language Runtime, and JavaScript engines. Like other Lisps, Clojure treats code as data and has a macro system.

wikipedia.org/wiki/Clojure

logo

How to use this image

Build tools

Clojure has three major approaches to building and running projects:

  1. leiningen
    1. The oldest and probably most common tool
  2. boot
    1. An alternative approach that solves similar problems as leiningen
  3. tools-deps
    1. A more recent official tool for some of the lein/boot use cases

There are variants of this image for all three of these tools and their respective releases. The most basic form of these tags is:

  1. clojure:lein
  2. clojure:boot
  3. clojure:tools-deps

But you can also append a hyphen and the version of that tool you'd like to use. For example, for lein 2.8.1 you can use this image: clojure:lein-2.8.1.

Run your app with leiningen

Add a Dockerfile to an existing Leiningen/Clojure project with the following contents:

FROM clojure
COPY . /usr/src/app
WORKDIR /usr/src/app
CMD ["lein", "run"]

Then, run these commands to build and run the image:

$ docker build -t my-clojure-app .
$ docker run -it --rm --name my-running-app my-clojure-app

While the above is the most straightforward example of a Dockerfile, it does have some drawbacks. The lein run command will download your dependencies, compile the project, and then run it. That's a lot of work, all of which you may not want done every time you run the image. To get around this, you can download the dependencies and compile the project ahead of time. This will significantly reduce startup time when you run your image.

FROM clojure
RUN mkdir -p /usr/src/app
WORKDIR /usr/src/app
COPY project.clj /usr/src/app/
RUN lein deps
COPY . /usr/src/app
RUN mv "$(lein uberjar | sed -n 's/^Created \(.*standalone\.jar\)/\1/p')" app-standalone.jar
CMD ["java", "-jar", "app-standalone.jar"]

Writing the Dockerfile this way will download the dependencies (and cache them, so they are only re-downloaded when the dependencies change) and then compile them into a standalone jar ahead of time rather than each time the image is run.

You can then build and run the image as above.

Compile your Lein/Clojure project into a jar from within the container

If you have an existing Lein/Clojure project, it's fairly straightforward to compile your project into a jar from a container:

$ docker run -it --rm -v "$PWD":/usr/src/app -w /usr/src/app clojure lein uberjar

This will build your project into a jar file located in your project's target/uberjar directory.

More details

See the official image README for more details about using this image with boot and tools-deps.

Image Variants

The clojure images come in many flavors, each designed for a specific use case.

clojure:<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.

Some of these tags may have names like bullseye in them. These are the suite code names for releases of Debian and indicate which release the image is based on. If your image needs to install any additional packages beyond what comes with the image, you'll likely want to specify one of these explicitly to minimize breakage when there are new releases of Debian.

Some of these tags may have names like focal or jammy in them. These are the suite code names for releases of Ubuntu and indicate which release the image is based on. If your image needs to install any additional packages beyond what comes with the image, you'll likely want to specify one of these explicitly to minimize breakage when there are new releases of Ubuntu.

clojure:<version>-slim

This image does not contain the common packages contained in the default tag and only contains the minimal packages needed to run clojure. Unless you are working in an environment where only the clojure image will be deployed and you have space constraints, we highly recommend using the default image of this repository.

clojure:<version>-alpine

This image is based on the popular Alpine Linux project, available in the alpine official image. Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.

This variant is useful when final image size being as small as possible is your primary concern. The main caveat to note is that it does use musl libc instead of glibc and friends, so software will often run into issues depending on the depth of their libc requirements/assumptions. See this Hacker News comment thread for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.

To minimize image size, it's uncommon for additional related tools (such as git or bash) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the alpine image description for examples of how to install packages if you are unfamiliar).

License

View license information for the software contained in this image.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

Some additional license information which was able to be auto-detected might be found in the repo-info repository's clojure/ directory.

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.