docs/haxe

Supported tags and respective Dockerfile links

• 3.4.3-stretch, 3.4-stretch, 3.4.3, 3.4, latest (3.4/stretch/Dockerfile)
• 3.4.3-jessie, 3.4-jessie (3.4/jessie/Dockerfile)
• 3.4.3-onbuild, 3.4-onbuild (3.4/onbuild/Dockerfile)
• 3.4.3-windowsservercore, 3.4-windowsservercore (3.4/windowsservercore/Dockerfile)
• 3.3.0-rc.1-stretch, 3.3.0-stretch, 3.3-stretch, 3.3.0-rc.1, 3.3.0, 3.3 (3.3/stretch/Dockerfile)
• 3.3.0-rc.1-jessie, 3.3.0-jessie, 3.3-jessie (3.3/jessie/Dockerfile)
• 3.3.0-rc.1-onbuild, 3.3.0-onbuild, 3.3-onbuild (3.3/onbuild/Dockerfile)
• 3.3.0-rc.1-windowsservercore, 3.3.0-windowsservercore, 3.3-windowsservercore (3.3/windowsservercore/Dockerfile)
• 3.2.1-stretch, 3.2-stretch, 3.2.1, 3.2 (3.2/stretch/Dockerfile)
• 3.2.1-jessie, 3.2-jessie (3.2/jessie/Dockerfile)
• 3.2.1-onbuild, 3.2-onbuild (3.2/onbuild/Dockerfile)
• 3.2.1-windowsservercore, 3.2-windowsservercore (3.2/windowsservercore/Dockerfile)
• 3.1.3-stretch, 3.1-stretch, 3.1.3, 3.1 (3.1/stretch/Dockerfile)
• 3.1.3-jessie, 3.1-jessie (3.1/jessie/Dockerfile)
• 3.1.3-onbuild, 3.1-onbuild (3.1/onbuild/Dockerfile)
• 3.1.3-windowsservercore, 3.1-windowsservercore (3.1/windowsservercore/Dockerfile)

Quick reference

• Where to get help:
  the Docker Community Forums, the Docker Community Slack, or Stack Overflow

• Where to file issues:
  https://github.com/HaxeFoundation/docker-library-haxe/issues

• Maintained by:
  the Haxe Foundation

• Supported architectures: (more info)
  amd64, windows-amd64

• Published image artifact details:
  repo-info repo's repos/haxe/ directory (history)
  (image metadata, transfer size, etc)

• Image updates:
  official-images PRs with label library/haxe
  official-images repo's library/haxe file (history)

• Source of this description:
  docs repo's haxe/ directory (history)

• Supported Docker versions:
  the latest release (down to 1.6 on a best-effort basis)

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 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 haxe:3.4-onbuild, we will get:

FROM 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 haxe images come in many flavors, each designed for a specific use case.

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.

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).

haxe:windowsservercore

This image is based on Windows Server Core (microsoft/windowsservercore). As such, it only works in places which that image does, such as Windows 10 Professional/Enterprise (Anniversary Edition) or Windows Server 2016.

For information about how to get Docker running on Windows, please see the relevant "Quick Start" guide provided by Microsoft:

• Windows Server Quick Start
• Windows 10 Quick Start

License

View license information for the software contained in this image.