Public Repository

Last pushed: 16 days ago
Short Description
Haxe is a modern, high level, static typed programming language with multiple compilation targets.
Full Description

Supported tags and respective Dockerfile links

(amd64/haxe build job)

Quick reference

What is Haxe?

Haxe is an open source toolkit based on a modern, high level, strictly typed programming language, a cross-compiler, a complete cross-platform standard library and ways to access each platform's native capabilities.

The Haxe compiler can output a number of source and binary files. As of Haxe 3.4.0-rc.1, the Haxe compiler can target JavaScript, Java, C#, C++, Python, PHP, Flash SWF, ActionScript 3, Lua, and Neko.

About this image

This image ships a minimal Haxe toolkit:

  • the haxe compiler with its standard library
  • the haxelib library manager
  • the neko virtual machine

How to use this image

The most straightforward way to use this image is to use a Haxe container as both the build and runtime environment. In your Dockerfile, writing something along the lines of the following will compile and run your project:

FROM amd64/haxe:3.4

RUN mkdir -p /usr/src/app
WORKDIR /usr/src/app

# install dependencies
COPY *.hxml /usr/src/app/
RUN yes | haxelib install all

# compile the project
COPY . /usr/src/app
RUN haxe build.hxml

# run the output when the container starts
CMD ["neko", "Main.n"]

Then, build and run the Docker image:

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

Using the onbuild variants

There are onbuild variants that include multiple ONBUILD triggers to perform all of the steps in the above Dockerfile, except there is no CMD instruction for running the compilation output.

Rewriting the above Dockerfile with amd64/haxe:3.4-onbuild, we will get:

FROM amd64/haxe:3.4-onbuild

# run the output when the container starts
CMD ["neko", "Main.n"]

The onbuild variants assume the main compilation hxml file is named build.hxml. To use another hxml file, set the BUILD_HXML build argument during build:

$ docker build -t my-haxe-app --build-arg BUILD_HXML=compile.hxml .

Image Variants

The amd64/haxe images come in many flavors, each designed for a specific use case.

amd64/haxe:<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.

amd64/haxe:onbuild

The ONBUILD image variants are deprecated, and their usage is discouraged. For more details, see docker-library/official-images#2076.

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, docker/docker#8240, docker/docker#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).

amd64/haxe: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 highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use musl libc instead of glibc and friends, so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. 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 haxe/ 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.

Docker Pull Command
Owner
amd64